Cisco-IOS-XR-ipv4-dhcpd-cfg API

IPV4-DHCPD - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Update operation of resource: ipv4-dhcpd

ipv4-dhcpd_schema

ipv4-dhcpdbody object

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 configurationPUTPOSTDELETEGET
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    "outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7"
    : {Enable DHCP binding database storage to file\nsystemPUTPOSTDELETEGET
      "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10" 
      "incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1" 
      "proxy": [ null ], DHCP proxy profile
      "snoop": [ null ], DHCP Snoop profile
      "server": [ null ] DHCP Server profile
    },    : {DHCP IPV4 Interface TablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "interface-name": "string", Interface Name
          : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
            : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "client-id": "string", Client Id
range: "0..4294967295" 
                  "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
                  "static-address": "string", IP address
                  "mac-address": "string" MACAddress
                }
              ]
            }
          },          : {Profile name and modePUTPOSTDELETEGET
            "profile-name": "string", Profile Name
            "mode": "enumeration" Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
          },          : {DHCP IPv4 Server informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 relay informationPUTPOSTDELETEGET
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
            : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "circuit-id-value": "string" Enter circuit-id value
            }
          }
        }
      ]
    },    : {Rate limit ingress packetsPUTPOSTDELETEGET
      "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200" 
      "num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100" 
    },
    "allow-client-id-change": [ null ], For BNG session, allow client id change for a\nclient MAC
    : {Allow Duplicate MAC AddressPUTPOSTDELETEGET
      "duplicate-mac": [ null ], Duplicate mac is allowed
      "exclude-vlan": [ null ], Exclude vlan
      "include-giaddr": [ null ] Include giaddr
    },    : {VRF TablePUTPOSTDELETEGET
      : [Specify match VRFPUTPOSTDELETEGET
        {          : {Profile name and modePUTPOSTDELETEGET
            "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
            "vrf-profile-name": "string" Profile name
          },
          "vrf-name": "string" VRF name
        }
      ]
    },
    "inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7"
    : {DHCP IPV4 Profile TablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
            : [Specify modePUTPOSTDELETEGET
              {                : {DHCP Relay profilePUTPOSTDELETEGET
                  : {GIADDR policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
                  },                  : {Broadcast Flag policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                  },                  : {VRF Helper AddressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper AddressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "gateway-address": "string", Gateway address
                              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                              "ip-address": "string" Server's IP address
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
                  : {Relay agent information optionPUTPOSTDELETEGET
                    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                    "subscriber-id": "string", Subscriber ID
                    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
                    : {Enter remote-id valuePUTPOSTDELETEGET
                      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                      "remote-id-value": "string" Enter remote-id value
                    },
                    "allow-untrusted": [ null ], Forward untrusted packets
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "vpn": [ null ], Insert VPN options
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {DHCP proxy profilePUTPOSTDELETEGET
                  : {Proxy limit leasePUTPOSTDELETEGET
                    "limit-lease-count": "string", Limit lease count
range: "1..240000" 
                    "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
                  },                  : {Specify broadcast flagPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                  },
                  "secure-arp": [ null ], Enable Secure Arp
                  : {Change sessions configurationPUTPOSTDELETEGET
                    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                      }
                    }
                  },                  : {Authentication Username formatingPUTPOSTDELETEGET
                    "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                    "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                  },                  : {Specify gateway address policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
                  },                  : {Insert match keywordPUTPOSTDELETEGET
                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                          "def-matchoption": "integer" Match option 60 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                          "matchoption": "integer", Match options 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  },                  : {DHCPv4 lease proxyPUTPOSTDELETEGET
                    "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
                    "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
                  },                  : {List of VRFsPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper addressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "server-address": "string", IPv4 address
                              "gateway-address": "string" Gateway address
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : {DHCP class tablePUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {                        : {Match optionPUTPOSTDELETEGET
                          : {Match optionPUTPOSTDELETEGET
                            "pattern": "string", Enter hex pattern string
                            "bit-mask": "string", Enter bit mask pattern string
                            "option-type": "enumeration" Match option
Options: 
                          },
                          "vrf": "string" Specify match VRF
                        },
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "class-name": "string", class name
                        : {List of VRFsPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "vrf-name": "string", VRF name
                              : {Helper addressesPUTPOSTDELETEGET
                                : [No descriptionPUTPOSTDELETEGET
                                  {
                                    "server-address": "string", IPv4 address
                                    "gateway-address": "string" Gateway address
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "proxy-allow-move": [ null ], Allow dhcp subscriber move
                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option": "integer", No description
range: "1..255" 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },                  : [Relay agent information optionPUTPOSTDELETEGET
                    {
                      "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                      "option": [ null ], No description
                      "remote-id-xr": [ null ], Insert Remote-id sub-option
                      "allow-untrusted": [ null ], Forward untrusted packets
                      "remote-id-suppress": [ null ], Suppress Remote ID
                      "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                      "remote-id": "string", Enter remote-id value
                      "circuit-id": [ null ], Insert Circuit-id sub-option
                      "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                      "vpn": [ null ], Insert VPN options
                      "check": [ null ] specify requested-ip-address-check disable
                    }
                  ]
                },                : {DHCP Snoop profilePUTPOSTDELETEGET
                  : {DHCP Snoop profilePUTPOSTDELETEGET
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                    : {Enter remote-id valuePUTPOSTDELETEGET
                      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                      "remote-id-value": "string" Enter remote-id value
                    },
                    "allow-untrusted": [ null ] Forward untrusted packets
                  },
                  "trusted": [ null ] Trusted sources
                },
                "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
                : {DHCP Base ProfilePUTPOSTDELETEGET
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : {Enable the default profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile Name
                    "profile-mode": "integer" none 
                  },                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option": "integer", No description
range: "1..255" 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchoption": "integer", Match options 
                            "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                            "format": "integer" Set constant integer 
                          }
                        ]
                      },                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "def-matchoption": "integer" Match option 60 
                          }
                        ]
                      }
                    }
                  ],                  : {Insert match keywordPUTPOSTDELETEGET
                    : {Table of ModeClassPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "class-name": "string", class name
                          : {Enter proxy or server profilePUTPOSTDELETEGET
                            "profile-name": "string", Profile Name
                            "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                          }
                        }
                      ]
                    },                    : {Specify match optionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "opt60": "integer", none
                          : {Enter a profilePUTPOSTDELETEGET
                            "profile-name": "string", Profile Name
                            "profile-mode": "integer" none 
                          },
                          "opt60-hex-str": "string", Enter hex pattern string
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  },                  : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
                    "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
                    "remote-id": "string" Enter remote-id value
                  },                  : {Default match optionPUTPOSTDELETEGET
                    : {Enter server profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "default-mode": "enumeration" Specify mode
Options:
 server 
                    }
                  }
                },                : {DHCP Server profilePUTPOSTDELETEGET
                  : {NetBIOS node typePUTPOSTDELETEGET
                    "hybrid-node": "string", Set string
                    "mixed-node": "string", Set string
                    "hexadecimal": "string", Hexadecimal number
                    "broadcast-node": "string", Set string
                    "peer-to-peer-node": "string" Set string
                  },
                  "subnet-mask": "string", Configure Subnet Mask
                  "domain-name": "string", Domain name
                  "boot-filename": "string", Boot Filename
                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option-number": "integer", Option number 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },
                  "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
                  "next-server": "string", Configure the tftp-server IP to be used\nby the client
                  : [Validate server ID checkPUTPOSTDELETEGET
                    {
                      "check": [ null ] specify requested-ip-address-check disable
                    }
                  ],
                  "server-allow-move": [ null ], Allow dhcp subscriber move
                  : {Specify limit leasePUTPOSTDELETEGET
                    "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
                    "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
                  },
                  "secure-arp": [ null ], Enable Secure Arp
                  : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
                    "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
                  },                  : {DNS serversPUTPOSTDELETEGET
                    "dns-server": "string" DNS Server's IP address
                  },
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : [NonePUTPOSTDELETEGET
                    {
                      "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
                    }
                  ],                  : {NetBIOS name serversPUTPOSTDELETEGET
                    "net-bios-name-server": "string" NetBIOSNameServer's IP address
                  },
                  "pool": "string", Specify the pool
                  : [Change sessions configurationPUTPOSTDELETEGET
                    {                      : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                        : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                          "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                          "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                          "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                        }
                      }
                    }
                  ],                  : {default routersPUTPOSTDELETEGET
                    "default-router": "string" Router's IP address
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {                      : {Table of OptionDefaultPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          }
                        ]
                      },                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                            "format": "integer" Set constant integer 
                          }
                        ]
                      }
                    }
                  ],                  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                      "force-insert": [ null ] Set constant integer
                    }
                  },                  : {Validate Requested IP AddressPUTPOSTDELETEGET
                    "check": [ null ] specify requested-ip-address-check disable
                  },                  : {Table of ClassPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {                        : {NetBIOS name serversPUTPOSTDELETEGET
                          "net-bios-name-server": "string" NetBIOSNameServer's IP address
                        },                        : [Insert match keywordPUTPOSTDELETEGET
                          {
                            "l2-interface": "string", Specify match l2-interface
                            : {Table of Class-OptionPUTPOSTDELETEGET
                              : [No descriptionPUTPOSTDELETEGET
                                {
                                  "pattern": "string", Enter hex pattern string
                                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                                  "bit-mask": "string" Enter bit mask pattern string
                                }
                              ]
                            },
                            "vrf": "string" Specify match VRF
                          }
                        ],                        : {default routersPUTPOSTDELETEGET
                          "default-router": "string" Router's IP address
                        },                        : [Table of OptionCodePUTPOSTDELETEGET
                          {                            : [DHCP option codePUTPOSTDELETEGET
                              {
                                "option-code": "integer", DHCP option code
range: "0..255" 
                                "hex-string": "string", Hexadecimal string
                                "ascii-string": "string", ASCII string
                                "ip-address": "string", Server's IP address
                                "force-insert": "integer" Set constant integer 
                              }
                            ]
                          }
                        ],
                        "subnet-mask": "string", Configure Subnet Mask
                        "boot-filename": "string", Boot Filename
                        "class-name": "string", class name
                        "domain-name": "string", Domain name
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "next-server": "string", Configure the tftp-server IP to be used\nby the client
                        : [NetBIOS node typePUTPOSTDELETEGET
                          {
                            "hybrid-node": "string", Set string
                            "mixed-node": "string", Set string
                            "hexadecimal": "string", Hexadecimal number
                            "broadcast-node": "string", Set string
                            "peer-to-peer-node": "string" Set string
                          }
                        ],                        : {DNS serversPUTPOSTDELETEGET
                          "dns-server": "string" DNS Server's IP address
                        },
                        "pool": "string", Specify the pool
                        : [leasePUTPOSTDELETEGET
                          {
                            "infinite": "string", Set string
                            "hours": "integer", Hours
range: "0..23"
units: "hour" 
                            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                            "days": "integer" Days
range: "0..365"
units: "day" 
                          }
                        ]
                      }
                    ]
                  },                  : {Table of OptionCodePUTPOSTDELETEGET
                    : [DHCP option codePUTPOSTDELETEGET
                      {
                        "option-code": "integer", DHCP option code
range: "0..255" 
                        "hex-string": "string", Hexadecimal string
                        "ascii-string": "string", ASCII string
                        "ip-address": "string", Server's IP address
                        "force-insert": "integer" Set constant integer 
                      }
                    ]
                  },                  : [leasePUTPOSTDELETEGET
                    {
                      "infinite": "string", Set string
                      "hours": "integer", Hours
range: "0..23"
units: "hour" 
                      "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                      "days": "integer" Days
range: "0..365"
units: "day" 
                    }
                  ]
                }
              }
            ]
          },
          "profile-name": "string" Profile Name
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-DHCPD - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Create operation of resource: ipv4-dhcpd

ipv4-dhcpd_schema

ipv4-dhcpdbody object

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 configurationPUTPOSTDELETEGET
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    "outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7"
    : {Enable DHCP binding database storage to file\nsystemPUTPOSTDELETEGET
      "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10" 
      "incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1" 
      "proxy": [ null ], DHCP proxy profile
      "snoop": [ null ], DHCP Snoop profile
      "server": [ null ] DHCP Server profile
    },    : {DHCP IPV4 Interface TablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "interface-name": "string", Interface Name
          : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
            : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "client-id": "string", Client Id
range: "0..4294967295" 
                  "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
                  "static-address": "string", IP address
                  "mac-address": "string" MACAddress
                }
              ]
            }
          },          : {Profile name and modePUTPOSTDELETEGET
            "profile-name": "string", Profile Name
            "mode": "enumeration" Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
          },          : {DHCP IPv4 Server informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 relay informationPUTPOSTDELETEGET
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
            : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "circuit-id-value": "string" Enter circuit-id value
            }
          }
        }
      ]
    },    : {Rate limit ingress packetsPUTPOSTDELETEGET
      "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200" 
      "num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100" 
    },
    "allow-client-id-change": [ null ], For BNG session, allow client id change for a\nclient MAC
    : {Allow Duplicate MAC AddressPUTPOSTDELETEGET
      "duplicate-mac": [ null ], Duplicate mac is allowed
      "exclude-vlan": [ null ], Exclude vlan
      "include-giaddr": [ null ] Include giaddr
    },    : {VRF TablePUTPOSTDELETEGET
      : [Specify match VRFPUTPOSTDELETEGET
        {          : {Profile name and modePUTPOSTDELETEGET
            "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
            "vrf-profile-name": "string" Profile name
          },
          "vrf-name": "string" VRF name
        }
      ]
    },
    "inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7"
    : {DHCP IPV4 Profile TablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
            : [Specify modePUTPOSTDELETEGET
              {                : {DHCP Relay profilePUTPOSTDELETEGET
                  : {GIADDR policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
                  },                  : {Broadcast Flag policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                  },                  : {VRF Helper AddressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper AddressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "gateway-address": "string", Gateway address
                              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                              "ip-address": "string" Server's IP address
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
                  : {Relay agent information optionPUTPOSTDELETEGET
                    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                    "subscriber-id": "string", Subscriber ID
                    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
                    : {Enter remote-id valuePUTPOSTDELETEGET
                      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                      "remote-id-value": "string" Enter remote-id value
                    },
                    "allow-untrusted": [ null ], Forward untrusted packets
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "vpn": [ null ], Insert VPN options
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {DHCP proxy profilePUTPOSTDELETEGET
                  : {Proxy limit leasePUTPOSTDELETEGET
                    "limit-lease-count": "string", Limit lease count
range: "1..240000" 
                    "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
                  },                  : {Specify broadcast flagPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                  },
                  "secure-arp": [ null ], Enable Secure Arp
                  : {Change sessions configurationPUTPOSTDELETEGET
                    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                      }
                    }
                  },                  : {Authentication Username formatingPUTPOSTDELETEGET
                    "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                    "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                  },                  : {Specify gateway address policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
                  },                  : {Insert match keywordPUTPOSTDELETEGET
                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                          "def-matchoption": "integer" Match option 60 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                          "matchoption": "integer", Match options 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  },                  : {DHCPv4 lease proxyPUTPOSTDELETEGET
                    "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
                    "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
                  },                  : {List of VRFsPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper addressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "server-address": "string", IPv4 address
                              "gateway-address": "string" Gateway address
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : {DHCP class tablePUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {                        : {Match optionPUTPOSTDELETEGET
                          : {Match optionPUTPOSTDELETEGET
                            "pattern": "string", Enter hex pattern string
                            "bit-mask": "string", Enter bit mask pattern string
                            "option-type": "enumeration" Match option
Options: 
                          },
                          "vrf": "string" Specify match VRF
                        },
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "class-name": "string", class name
                        : {List of VRFsPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "vrf-name": "string", VRF name
                              : {Helper addressesPUTPOSTDELETEGET
                                : [No descriptionPUTPOSTDELETEGET
                                  {
                                    "server-address": "string", IPv4 address
                                    "gateway-address": "string" Gateway address
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "proxy-allow-move": [ null ], Allow dhcp subscriber move
                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option": "integer", No description
range: "1..255" 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },                  : [Relay agent information optionPUTPOSTDELETEGET
                    {
                      "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                      "option": [ null ], No description
                      "remote-id-xr": [ null ], Insert Remote-id sub-option
                      "allow-untrusted": [ null ], Forward untrusted packets
                      "remote-id-suppress": [ null ], Suppress Remote ID
                      "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                      "remote-id": "string", Enter remote-id value
                      "circuit-id": [ null ], Insert Circuit-id sub-option
                      "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                      "vpn": [ null ], Insert VPN options
                      "check": [ null ] specify requested-ip-address-check disable
                    }
                  ]
                },                : {DHCP Snoop profilePUTPOSTDELETEGET
                  : {DHCP Snoop profilePUTPOSTDELETEGET
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                    : {Enter remote-id valuePUTPOSTDELETEGET
                      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                      "remote-id-value": "string" Enter remote-id value
                    },
                    "allow-untrusted": [ null ] Forward untrusted packets
                  },
                  "trusted": [ null ] Trusted sources
                },
                "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
                : {DHCP Base ProfilePUTPOSTDELETEGET
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : {Enable the default profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile Name
                    "profile-mode": "integer" none 
                  },                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option": "integer", No description
range: "1..255" 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchoption": "integer", Match options 
                            "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                            "format": "integer" Set constant integer 
                          }
                        ]
                      },                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "def-matchoption": "integer" Match option 60 
                          }
                        ]
                      }
                    }
                  ],                  : {Insert match keywordPUTPOSTDELETEGET
                    : {Table of ModeClassPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "class-name": "string", class name
                          : {Enter proxy or server profilePUTPOSTDELETEGET
                            "profile-name": "string", Profile Name
                            "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                          }
                        }
                      ]
                    },                    : {Specify match optionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "opt60": "integer", none
                          : {Enter a profilePUTPOSTDELETEGET
                            "profile-name": "string", Profile Name
                            "profile-mode": "integer" none 
                          },
                          "opt60-hex-str": "string", Enter hex pattern string
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  },                  : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
                    "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
                    "remote-id": "string" Enter remote-id value
                  },                  : {Default match optionPUTPOSTDELETEGET
                    : {Enter server profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "default-mode": "enumeration" Specify mode
Options:
 server 
                    }
                  }
                },                : {DHCP Server profilePUTPOSTDELETEGET
                  : {NetBIOS node typePUTPOSTDELETEGET
                    "hybrid-node": "string", Set string
                    "mixed-node": "string", Set string
                    "hexadecimal": "string", Hexadecimal number
                    "broadcast-node": "string", Set string
                    "peer-to-peer-node": "string" Set string
                  },
                  "subnet-mask": "string", Configure Subnet Mask
                  "domain-name": "string", Domain name
                  "boot-filename": "string", Boot Filename
                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option-number": "integer", Option number 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },
                  "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
                  "next-server": "string", Configure the tftp-server IP to be used\nby the client
                  : [Validate server ID checkPUTPOSTDELETEGET
                    {
                      "check": [ null ] specify requested-ip-address-check disable
                    }
                  ],
                  "server-allow-move": [ null ], Allow dhcp subscriber move
                  : {Specify limit leasePUTPOSTDELETEGET
                    "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
                    "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
                  },
                  "secure-arp": [ null ], Enable Secure Arp
                  : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
                    "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
                  },                  : {DNS serversPUTPOSTDELETEGET
                    "dns-server": "string" DNS Server's IP address
                  },
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : [NonePUTPOSTDELETEGET
                    {
                      "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
                    }
                  ],                  : {NetBIOS name serversPUTPOSTDELETEGET
                    "net-bios-name-server": "string" NetBIOSNameServer's IP address
                  },
                  "pool": "string", Specify the pool
                  : [Change sessions configurationPUTPOSTDELETEGET
                    {                      : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                        : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                          "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                          "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                          "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                        }
                      }
                    }
                  ],                  : {default routersPUTPOSTDELETEGET
                    "default-router": "string" Router's IP address
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {                      : {Table of OptionDefaultPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          }
                        ]
                      },                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                            "format": "integer" Set constant integer 
                          }
                        ]
                      }
                    }
                  ],                  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                      "force-insert": [ null ] Set constant integer
                    }
                  },                  : {Validate Requested IP AddressPUTPOSTDELETEGET
                    "check": [ null ] specify requested-ip-address-check disable
                  },                  : {Table of ClassPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {                        : {NetBIOS name serversPUTPOSTDELETEGET
                          "net-bios-name-server": "string" NetBIOSNameServer's IP address
                        },                        : [Insert match keywordPUTPOSTDELETEGET
                          {
                            "l2-interface": "string", Specify match l2-interface
                            : {Table of Class-OptionPUTPOSTDELETEGET
                              : [No descriptionPUTPOSTDELETEGET
                                {
                                  "pattern": "string", Enter hex pattern string
                                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                                  "bit-mask": "string" Enter bit mask pattern string
                                }
                              ]
                            },
                            "vrf": "string" Specify match VRF
                          }
                        ],                        : {default routersPUTPOSTDELETEGET
                          "default-router": "string" Router's IP address
                        },                        : [Table of OptionCodePUTPOSTDELETEGET
                          {                            : [DHCP option codePUTPOSTDELETEGET
                              {
                                "option-code": "integer", DHCP option code
range: "0..255" 
                                "hex-string": "string", Hexadecimal string
                                "ascii-string": "string", ASCII string
                                "ip-address": "string", Server's IP address
                                "force-insert": "integer" Set constant integer 
                              }
                            ]
                          }
                        ],
                        "subnet-mask": "string", Configure Subnet Mask
                        "boot-filename": "string", Boot Filename
                        "class-name": "string", class name
                        "domain-name": "string", Domain name
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "next-server": "string", Configure the tftp-server IP to be used\nby the client
                        : [NetBIOS node typePUTPOSTDELETEGET
                          {
                            "hybrid-node": "string", Set string
                            "mixed-node": "string", Set string
                            "hexadecimal": "string", Hexadecimal number
                            "broadcast-node": "string", Set string
                            "peer-to-peer-node": "string" Set string
                          }
                        ],                        : {DNS serversPUTPOSTDELETEGET
                          "dns-server": "string" DNS Server's IP address
                        },
                        "pool": "string", Specify the pool
                        : [leasePUTPOSTDELETEGET
                          {
                            "infinite": "string", Set string
                            "hours": "integer", Hours
range: "0..23"
units: "hour" 
                            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                            "days": "integer" Days
range: "0..365"
units: "day" 
                          }
                        ]
                      }
                    ]
                  },                  : {Table of OptionCodePUTPOSTDELETEGET
                    : [DHCP option codePUTPOSTDELETEGET
                      {
                        "option-code": "integer", DHCP option code
range: "0..255" 
                        "hex-string": "string", Hexadecimal string
                        "ascii-string": "string", ASCII string
                        "ip-address": "string", Server's IP address
                        "force-insert": "integer" Set constant integer 
                      }
                    ]
                  },                  : [leasePUTPOSTDELETEGET
                    {
                      "infinite": "string", Set string
                      "hours": "integer", Hours
range: "0..23"
units: "hour" 
                      "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                      "days": "integer" Days
range: "0..365"
units: "day" 
                    }
                  ]
                }
              }
            ]
          },
          "profile-name": "string" Profile Name
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-DHCPD - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Delete operation of resource: ipv4-dhcpd

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-DHCPD - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Retrieve operation of resource: ipv4-dhcpd

200 OK

ipv4-dhcpd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPV4 configurationPUTPOSTDELETEGET
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    "outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7"
    : {Enable DHCP binding database storage to file\nsystemPUTPOSTDELETEGET
      "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10" 
      "incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1" 
      "proxy": [ null ], DHCP proxy profile
      "snoop": [ null ], DHCP Snoop profile
      "server": [ null ] DHCP Server profile
    },    : {DHCP IPV4 Interface TablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "interface-name": "string", Interface Name
          : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
            : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "client-id": "string", Client Id
range: "0..4294967295" 
                  "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
                  "static-address": "string", IP address
                  "mac-address": "string" MACAddress
                }
              ]
            }
          },          : {Profile name and modePUTPOSTDELETEGET
            "profile-name": "string", Profile Name
            "mode": "enumeration" Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
          },          : {DHCP IPv4 Server informationPUTPOSTDELETEGET
            "profile": "string", Profile name and mode
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 relay informationPUTPOSTDELETEGET
            : {Circuit ID valuePUTPOSTDELETEGET
              "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "format": "enumeration", Set constant integer
Options:
 no-format
 hex
 ascii
 extended 
              "circuit-id": "string", Insert Circuit-id sub-option
              "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
              "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            }
          },          : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
            : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "circuit-id-value": "string" Enter circuit-id value
            }
          }
        }
      ]
    },    : {Rate limit ingress packetsPUTPOSTDELETEGET
      "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200" 
      "num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100" 
    },
    "allow-client-id-change": [ null ], For BNG session, allow client id change for a\nclient MAC
    : {Allow Duplicate MAC AddressPUTPOSTDELETEGET
      "duplicate-mac": [ null ], Duplicate mac is allowed
      "exclude-vlan": [ null ], Exclude vlan
      "include-giaddr": [ null ] Include giaddr
    },    : {VRF TablePUTPOSTDELETEGET
      : [Specify match VRFPUTPOSTDELETEGET
        {          : {Profile name and modePUTPOSTDELETEGET
            "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
            "vrf-profile-name": "string" Profile name
          },
          "vrf-name": "string" VRF name
        }
      ]
    },
    "inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7"
    : {DHCP IPV4 Profile TablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
            : [Specify modePUTPOSTDELETEGET
              {                : {DHCP Relay profilePUTPOSTDELETEGET
                  : {GIADDR policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
                  },                  : {Broadcast Flag policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                  },                  : {VRF Helper AddressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper AddressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "gateway-address": "string", Gateway address
                              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                              "ip-address": "string" Server's IP address
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
                  : {Relay agent information optionPUTPOSTDELETEGET
                    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                    "subscriber-id": "string", Subscriber ID
                    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
                    : {Enter remote-id valuePUTPOSTDELETEGET
                      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                      "remote-id-value": "string" Enter remote-id value
                    },
                    "allow-untrusted": [ null ], Forward untrusted packets
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "vpn": [ null ], Insert VPN options
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {DHCP proxy profilePUTPOSTDELETEGET
                  : {Proxy limit leasePUTPOSTDELETEGET
                    "limit-lease-count": "string", Limit lease count
range: "1..240000" 
                    "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
                  },                  : {Specify broadcast flagPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                  },
                  "secure-arp": [ null ], Enable Secure Arp
                  : {Change sessions configurationPUTPOSTDELETEGET
                    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                      }
                    }
                  },                  : {Authentication Username formatingPUTPOSTDELETEGET
                    "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                    "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                  },                  : {Specify gateway address policyPUTPOSTDELETEGET
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
                  },                  : {Insert match keywordPUTPOSTDELETEGET
                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                          "def-matchoption": "integer" Match option 60 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                          "matchoption": "integer", Match options 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  },                  : {DHCPv4 lease proxyPUTPOSTDELETEGET
                    "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
                    "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
                  },                  : {List of VRFsPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper addressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "server-address": "string", IPv4 address
                              "gateway-address": "string" Gateway address
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : {DHCP class tablePUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {                        : {Match optionPUTPOSTDELETEGET
                          : {Match optionPUTPOSTDELETEGET
                            "pattern": "string", Enter hex pattern string
                            "bit-mask": "string", Enter bit mask pattern string
                            "option-type": "enumeration" Match option
Options: 
                          },
                          "vrf": "string" Specify match VRF
                        },
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "class-name": "string", class name
                        : {List of VRFsPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "vrf-name": "string", VRF name
                              : {Helper addressesPUTPOSTDELETEGET
                                : [No descriptionPUTPOSTDELETEGET
                                  {
                                    "server-address": "string", IPv4 address
                                    "gateway-address": "string" Gateway address
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "proxy-allow-move": [ null ], Allow dhcp subscriber move
                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option": "integer", No description
range: "1..255" 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },                  : [Relay agent information optionPUTPOSTDELETEGET
                    {
                      "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                      "option": [ null ], No description
                      "remote-id-xr": [ null ], Insert Remote-id sub-option
                      "allow-untrusted": [ null ], Forward untrusted packets
                      "remote-id-suppress": [ null ], Suppress Remote ID
                      "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                      "remote-id": "string", Enter remote-id value
                      "circuit-id": [ null ], Insert Circuit-id sub-option
                      "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                      "vpn": [ null ], Insert VPN options
                      "check": [ null ] specify requested-ip-address-check disable
                    }
                  ]
                },                : {DHCP Snoop profilePUTPOSTDELETEGET
                  : {DHCP Snoop profilePUTPOSTDELETEGET
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                    : {Enter remote-id valuePUTPOSTDELETEGET
                      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                      "remote-id-value": "string" Enter remote-id value
                    },
                    "allow-untrusted": [ null ] Forward untrusted packets
                  },
                  "trusted": [ null ] Trusted sources
                },
                "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
                : {DHCP Base ProfilePUTPOSTDELETEGET
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : {Enable the default profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile Name
                    "profile-mode": "integer" none 
                  },                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option": "integer", No description
range: "1..255" 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchoption": "integer", Match options 
                            "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                            "format": "integer" Set constant integer 
                          }
                        ]
                      },                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "def-matchoption": "integer" Match option 60 
                          }
                        ]
                      }
                    }
                  ],                  : {Insert match keywordPUTPOSTDELETEGET
                    : {Table of ModeClassPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "class-name": "string", class name
                          : {Enter proxy or server profilePUTPOSTDELETEGET
                            "profile-name": "string", Profile Name
                            "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                          }
                        }
                      ]
                    },                    : {Specify match optionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "opt60": "integer", none
                          : {Enter a profilePUTPOSTDELETEGET
                            "profile-name": "string", Profile Name
                            "profile-mode": "integer" none 
                          },
                          "opt60-hex-str": "string", Enter hex pattern string
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  },                  : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
                    "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
                    "remote-id": "string" Enter remote-id value
                  },                  : {Default match optionPUTPOSTDELETEGET
                    : {Enter server profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "default-mode": "enumeration" Specify mode
Options:
 server 
                    }
                  }
                },                : {DHCP Server profilePUTPOSTDELETEGET
                  : {NetBIOS node typePUTPOSTDELETEGET
                    "hybrid-node": "string", Set string
                    "mixed-node": "string", Set string
                    "hexadecimal": "string", Hexadecimal number
                    "broadcast-node": "string", Set string
                    "peer-to-peer-node": "string" Set string
                  },
                  "subnet-mask": "string", Configure Subnet Mask
                  "domain-name": "string", Domain name
                  "boot-filename": "string", Boot Filename
                  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                    : {option typePUTPOSTDELETEGET
                      : {List of optionsPUTPOSTDELETEGET
                        "option-number": "integer", Option number 
                        "option-all": "integer" Set constant integer 
                      }
                    }
                  },
                  "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
                  "next-server": "string", Configure the tftp-server IP to be used\nby the client
                  : [Validate server ID checkPUTPOSTDELETEGET
                    {
                      "check": [ null ] specify requested-ip-address-check disable
                    }
                  ],
                  "server-allow-move": [ null ], Allow dhcp subscriber move
                  : {Specify limit leasePUTPOSTDELETEGET
                    "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
                    "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
                  },
                  "secure-arp": [ null ], Enable Secure Arp
                  : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
                    "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
                  },                  : {DNS serversPUTPOSTDELETEGET
                    "dns-server": "string" DNS Server's IP address
                  },
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  : [NonePUTPOSTDELETEGET
                    {
                      "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
                    }
                  ],                  : {NetBIOS name serversPUTPOSTDELETEGET
                    "net-bios-name-server": "string" NetBIOSNameServer's IP address
                  },
                  "pool": "string", Specify the pool
                  : [Change sessions configurationPUTPOSTDELETEGET
                    {                      : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                        : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                          "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                          "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                          "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                        }
                      }
                    }
                  ],                  : {default routersPUTPOSTDELETEGET
                    "default-router": "string" Router's IP address
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {                      : {Table of OptionDefaultPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          }
                        ]
                      },                      : {Table of OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                            "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                            "format": "integer" Set constant integer 
                          }
                        ]
                      }
                    }
                  ],                  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                      "force-insert": [ null ] Set constant integer
                    }
                  },                  : {Validate Requested IP AddressPUTPOSTDELETEGET
                    "check": [ null ] specify requested-ip-address-check disable
                  },                  : {Table of ClassPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {                        : {NetBIOS name serversPUTPOSTDELETEGET
                          "net-bios-name-server": "string" NetBIOSNameServer's IP address
                        },                        : [Insert match keywordPUTPOSTDELETEGET
                          {
                            "l2-interface": "string", Specify match l2-interface
                            : {Table of Class-OptionPUTPOSTDELETEGET
                              : [No descriptionPUTPOSTDELETEGET
                                {
                                  "pattern": "string", Enter hex pattern string
                                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                                  "bit-mask": "string" Enter bit mask pattern string
                                }
                              ]
                            },
                            "vrf": "string" Specify match VRF
                          }
                        ],                        : {default routersPUTPOSTDELETEGET
                          "default-router": "string" Router's IP address
                        },                        : [Table of OptionCodePUTPOSTDELETEGET
                          {                            : [DHCP option codePUTPOSTDELETEGET
                              {
                                "option-code": "integer", DHCP option code
range: "0..255" 
                                "hex-string": "string", Hexadecimal string
                                "ascii-string": "string", ASCII string
                                "ip-address": "string", Server's IP address
                                "force-insert": "integer" Set constant integer 
                              }
                            ]
                          }
                        ],
                        "subnet-mask": "string", Configure Subnet Mask
                        "boot-filename": "string", Boot Filename
                        "class-name": "string", class name
                        "domain-name": "string", Domain name
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "next-server": "string", Configure the tftp-server IP to be used\nby the client
                        : [NetBIOS node typePUTPOSTDELETEGET
                          {
                            "hybrid-node": "string", Set string
                            "mixed-node": "string", Set string
                            "hexadecimal": "string", Hexadecimal number
                            "broadcast-node": "string", Set string
                            "peer-to-peer-node": "string" Set string
                          }
                        ],                        : {DNS serversPUTPOSTDELETEGET
                          "dns-server": "string" DNS Server's IP address
                        },
                        "pool": "string", Specify the pool
                        : [leasePUTPOSTDELETEGET
                          {
                            "infinite": "string", Set string
                            "hours": "integer", Hours
range: "0..23"
units: "hour" 
                            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                            "days": "integer" Days
range: "0..365"
units: "day" 
                          }
                        ]
                      }
                    ]
                  },                  : {Table of OptionCodePUTPOSTDELETEGET
                    : [DHCP option codePUTPOSTDELETEGET
                      {
                        "option-code": "integer", DHCP option code
range: "0..255" 
                        "hex-string": "string", Hexadecimal string
                        "ascii-string": "string", ASCII string
                        "ip-address": "string", Server's IP address
                        "force-insert": "integer" Set constant integer 
                      }
                    ]
                  },                  : [leasePUTPOSTDELETEGET
                    {
                      "infinite": "string", Set string
                      "hours": "integer", Hours
range: "0..23"
units: "hour" 
                      "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                      "days": "integer" Days
range: "0..365"
units: "day" 
                    }
                  ]
                }
              }
            ]
          },
          "profile-name": "string" Profile Name
        }
      ]
    }
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json

Request Example

{  : {VRF TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {Profile name and modePUTPOSTDELETEGET
          "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
          "vrf-profile-name": "string" Profile name
        },
        "vrf-name": "string" VRF Name
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json

Request Example

{  : {VRF TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {Profile name and modePUTPOSTDELETEGET
          "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
          "vrf-profile-name": "string" Profile name
        },
        "vrf-name": "string" VRF Name
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Retrieve operation of resource: vrfs

200 OK

vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {VRF TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {Profile name and modePUTPOSTDELETEGET
          "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
          "vrf-profile-name": "string" Profile name
        },
        "vrf-name": "string" VRF Name
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {      : {Profile name and modePUTPOSTDELETEGET
        "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
        "vrf-profile-name": "string" Profile name
      },
      "vrf-name": "string" VRF Name
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {      : {Profile name and modePUTPOSTDELETEGET
        "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
        "vrf-profile-name": "string" Profile name
      },
      "vrf-name": "string" VRF Name
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string

in path

ID of vrf-name

200 OK

vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {      : {Profile name and modePUTPOSTDELETEGET
        "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
        "vrf-profile-name": "string" Profile name
      },
      "vrf-name": "string" VRF Name
    }
  ]
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Update operation of resource: profile

profile_schema

profilebody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Profile name and modePUTPOSTDELETEGET
    "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
    "vrf-profile-name": "string" Profile name
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Create operation of resource: profile

profile_schema

profilebody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Profile name and modePUTPOSTDELETEGET
    "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
    "vrf-profile-name": "string" Profile name
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Delete operation of resource: profile

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Retrieve operation of resource: profile

vrf-name: string

in path

ID of vrf-name

200 OK

profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Profile name and modePUTPOSTDELETEGET
    "mode": "enumeration", Dhcp mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
    "vrf-profile-name": "string" Profile name
  }
}

PROFILES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Update operation of resource: profiles

profiles_schema

profilesbody object

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 Profile TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
          : [Specify modePUTPOSTDELETEGET
            {              : {DHCP Relay profilePUTPOSTDELETEGET
                : {GIADDR policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
                },                : {Broadcast Flag policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                },                : {VRF Helper AddressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper AddressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "gateway-address": "string", Gateway address
                            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                            "ip-address": "string" Server's IP address
                          }
                        ]
                      }
                    }
                  ]
                },
                "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
                : {Relay agent information optionPUTPOSTDELETEGET
                  "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                  "subscriber-id": "string", Subscriber ID
                  "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
                  : {Enter remote-id valuePUTPOSTDELETEGET
                    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                    "remote-id-value": "string" Enter remote-id value
                  },
                  "allow-untrusted": [ null ], Forward untrusted packets
                  "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                  "vpn": [ null ], Insert VPN options
                  "check": [ null ] specify requested-ip-address-check disable
                }
              },
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              : {DHCP proxy profilePUTPOSTDELETEGET
                : {Proxy limit leasePUTPOSTDELETEGET
                  "limit-lease-count": "string", Limit lease count
range: "1..240000" 
                  "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
                },                : {Specify broadcast flagPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                },
                "secure-arp": [ null ], Enable Secure Arp
                : {Change sessions configurationPUTPOSTDELETEGET
                  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                    }
                  }
                },                : {Authentication Username formatingPUTPOSTDELETEGET
                  "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                  "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                },                : {Specify gateway address policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
                },                : {Insert match keywordPUTPOSTDELETEGET
                  : {Table of OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                        "def-matchoption": "integer" Match option 60 
                      }
                    ]
                  },                  : {Table of OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "pattern": "string", Enter hex pattern string
                        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                        "matchoption": "integer", Match options 
                        "format": "integer" Set constant integer 
                      }
                    ]
                  }
                },                : {DHCPv4 lease proxyPUTPOSTDELETEGET
                  "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
                  "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
                },                : {List of VRFsPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper addressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "server-address": "string", IPv4 address
                            "gateway-address": "string" Gateway address
                          }
                        ]
                      }
                    }
                  ]
                },
                "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {DHCP class tablePUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {                      : {Match optionPUTPOSTDELETEGET
                        : {Match optionPUTPOSTDELETEGET
                          "pattern": "string", Enter hex pattern string
                          "bit-mask": "string", Enter bit mask pattern string
                          "option-type": "enumeration" Match option
Options: 
                        },
                        "vrf": "string" Specify match VRF
                      },
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "class-name": "string", class name
                      : {List of VRFsPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "vrf-name": "string", VRF name
                            : {Helper addressesPUTPOSTDELETEGET
                              : [No descriptionPUTPOSTDELETEGET
                                {
                                  "server-address": "string", IPv4 address
                                  "gateway-address": "string" Gateway address
                                }
                              ]
                            }
                          }
                        ]
                      }
                    }
                  ]
                },
                "proxy-allow-move": [ null ], Allow dhcp subscriber move
                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option": "integer", No description
range: "1..255" 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },                : [Relay agent information optionPUTPOSTDELETEGET
                  {
                    "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                    "option": [ null ], No description
                    "remote-id-xr": [ null ], Insert Remote-id sub-option
                    "allow-untrusted": [ null ], Forward untrusted packets
                    "remote-id-suppress": [ null ], Suppress Remote ID
                    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                    "remote-id": "string", Enter remote-id value
                    "circuit-id": [ null ], Insert Circuit-id sub-option
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "vpn": [ null ], Insert VPN options
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                ]
              },              : {DHCP Snoop profilePUTPOSTDELETEGET
                : {DHCP Snoop profilePUTPOSTDELETEGET
                  "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                  "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                  : {Enter remote-id valuePUTPOSTDELETEGET
                    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                    "remote-id-value": "string" Enter remote-id value
                  },
                  "allow-untrusted": [ null ] Forward untrusted packets
                },
                "trusted": [ null ] Trusted sources
              },
              "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
              : {DHCP Base ProfilePUTPOSTDELETEGET
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {Enable the default profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile Name
                  "profile-mode": "integer" none 
                },                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option": "integer", No description
range: "1..255" 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchoption": "integer", Match options 
                          "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "def-matchoption": "integer" Match option 60 
                        }
                      ]
                    }
                  }
                ],                : {Insert match keywordPUTPOSTDELETEGET
                  : {Table of ModeClassPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "class-name": "string", class name
                        : {Enter proxy or server profilePUTPOSTDELETEGET
                          "profile-name": "string", Profile Name
                          "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                        }
                      }
                    ]
                  },                  : {Specify match optionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "opt60": "integer", none
                        : {Enter a profilePUTPOSTDELETEGET
                          "profile-name": "string", Profile Name
                          "profile-mode": "integer" none 
                        },
                        "opt60-hex-str": "string", Enter hex pattern string
                        "format": "integer" Set constant integer 
                      }
                    ]
                  }
                },                : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
                  "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
                  "remote-id": "string" Enter remote-id value
                },                : {Default match optionPUTPOSTDELETEGET
                  : {Enter server profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile Name
                    "default-mode": "enumeration" Specify mode
Options:
 server 
                  }
                }
              },              : {DHCP Server profilePUTPOSTDELETEGET
                : {NetBIOS node typePUTPOSTDELETEGET
                  "hybrid-node": "string", Set string
                  "mixed-node": "string", Set string
                  "hexadecimal": "string", Hexadecimal number
                  "broadcast-node": "string", Set string
                  "peer-to-peer-node": "string" Set string
                },
                "subnet-mask": "string", Configure Subnet Mask
                "domain-name": "string", Domain name
                "boot-filename": "string", Boot Filename
                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option-number": "integer", Option number 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },
                "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
                "next-server": "string", Configure the tftp-server IP to be used\nby the client
                : [Validate server ID checkPUTPOSTDELETEGET
                  {
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                ],
                "server-allow-move": [ null ], Allow dhcp subscriber move
                : {Specify limit leasePUTPOSTDELETEGET
                  "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
                  "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
                },
                "secure-arp": [ null ], Enable Secure Arp
                : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
                  "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
                },                : {DNS serversPUTPOSTDELETEGET
                  "dns-server": "string" DNS Server's IP address
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : [NonePUTPOSTDELETEGET
                  {
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
                  }
                ],                : {NetBIOS name serversPUTPOSTDELETEGET
                  "net-bios-name-server": "string" NetBIOSNameServer's IP address
                },
                "pool": "string", Specify the pool
                : [Change sessions configurationPUTPOSTDELETEGET
                  {                    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                      }
                    }
                  }
                ],                : {default routersPUTPOSTDELETEGET
                  "default-router": "string" Router's IP address
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {                    : {Table of OptionDefaultPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  }
                ],                : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                    "force-insert": [ null ] Set constant integer
                  }
                },                : {Validate Requested IP AddressPUTPOSTDELETEGET
                  "check": [ null ] specify requested-ip-address-check disable
                },                : {Table of ClassPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {                      : {NetBIOS name serversPUTPOSTDELETEGET
                        "net-bios-name-server": "string" NetBIOSNameServer's IP address
                      },                      : [Insert match keywordPUTPOSTDELETEGET
                        {
                          "l2-interface": "string", Specify match l2-interface
                          : {Table of Class-OptionPUTPOSTDELETEGET
                            : [No descriptionPUTPOSTDELETEGET
                              {
                                "pattern": "string", Enter hex pattern string
                                "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                                "bit-mask": "string" Enter bit mask pattern string
                              }
                            ]
                          },
                          "vrf": "string" Specify match VRF
                        }
                      ],                      : {default routersPUTPOSTDELETEGET
                        "default-router": "string" Router's IP address
                      },                      : [Table of OptionCodePUTPOSTDELETEGET
                        {                          : [DHCP option codePUTPOSTDELETEGET
                            {
                              "option-code": "integer", DHCP option code
range: "0..255" 
                              "hex-string": "string", Hexadecimal string
                              "ascii-string": "string", ASCII string
                              "ip-address": "string", Server's IP address
                              "force-insert": "integer" Set constant integer 
                            }
                          ]
                        }
                      ],
                      "subnet-mask": "string", Configure Subnet Mask
                      "boot-filename": "string", Boot Filename
                      "class-name": "string", class name
                      "domain-name": "string", Domain name
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "next-server": "string", Configure the tftp-server IP to be used\nby the client
                      : [NetBIOS node typePUTPOSTDELETEGET
                        {
                          "hybrid-node": "string", Set string
                          "mixed-node": "string", Set string
                          "hexadecimal": "string", Hexadecimal number
                          "broadcast-node": "string", Set string
                          "peer-to-peer-node": "string" Set string
                        }
                      ],                      : {DNS serversPUTPOSTDELETEGET
                        "dns-server": "string" DNS Server's IP address
                      },
                      "pool": "string", Specify the pool
                      : [leasePUTPOSTDELETEGET
                        {
                          "infinite": "string", Set string
                          "hours": "integer", Hours
range: "0..23"
units: "hour" 
                          "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                          "days": "integer" Days
range: "0..365"
units: "day" 
                        }
                      ]
                    }
                  ]
                },                : {Table of OptionCodePUTPOSTDELETEGET
                  : [DHCP option codePUTPOSTDELETEGET
                    {
                      "option-code": "integer", DHCP option code
range: "0..255" 
                      "hex-string": "string", Hexadecimal string
                      "ascii-string": "string", ASCII string
                      "ip-address": "string", Server's IP address
                      "force-insert": "integer" Set constant integer 
                    }
                  ]
                },                : [leasePUTPOSTDELETEGET
                  {
                    "infinite": "string", Set string
                    "hours": "integer", Hours
range: "0..23"
units: "hour" 
                    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                    "days": "integer" Days
range: "0..365"
units: "day" 
                  }
                ]
              }
            }
          ]
        },
        "profile-name": "string" Profile Name
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Create operation of resource: profiles

profiles_schema

profilesbody object

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 Profile TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
          : [Specify modePUTPOSTDELETEGET
            {              : {DHCP Relay profilePUTPOSTDELETEGET
                : {GIADDR policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
                },                : {Broadcast Flag policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                },                : {VRF Helper AddressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper AddressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "gateway-address": "string", Gateway address
                            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                            "ip-address": "string" Server's IP address
                          }
                        ]
                      }
                    }
                  ]
                },
                "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
                : {Relay agent information optionPUTPOSTDELETEGET
                  "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                  "subscriber-id": "string", Subscriber ID
                  "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
                  : {Enter remote-id valuePUTPOSTDELETEGET
                    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                    "remote-id-value": "string" Enter remote-id value
                  },
                  "allow-untrusted": [ null ], Forward untrusted packets
                  "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                  "vpn": [ null ], Insert VPN options
                  "check": [ null ] specify requested-ip-address-check disable
                }
              },
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              : {DHCP proxy profilePUTPOSTDELETEGET
                : {Proxy limit leasePUTPOSTDELETEGET
                  "limit-lease-count": "string", Limit lease count
range: "1..240000" 
                  "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
                },                : {Specify broadcast flagPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                },
                "secure-arp": [ null ], Enable Secure Arp
                : {Change sessions configurationPUTPOSTDELETEGET
                  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                    }
                  }
                },                : {Authentication Username formatingPUTPOSTDELETEGET
                  "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                  "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                },                : {Specify gateway address policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
                },                : {Insert match keywordPUTPOSTDELETEGET
                  : {Table of OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                        "def-matchoption": "integer" Match option 60 
                      }
                    ]
                  },                  : {Table of OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "pattern": "string", Enter hex pattern string
                        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                        "matchoption": "integer", Match options 
                        "format": "integer" Set constant integer 
                      }
                    ]
                  }
                },                : {DHCPv4 lease proxyPUTPOSTDELETEGET
                  "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
                  "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
                },                : {List of VRFsPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper addressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "server-address": "string", IPv4 address
                            "gateway-address": "string" Gateway address
                          }
                        ]
                      }
                    }
                  ]
                },
                "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {DHCP class tablePUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {                      : {Match optionPUTPOSTDELETEGET
                        : {Match optionPUTPOSTDELETEGET
                          "pattern": "string", Enter hex pattern string
                          "bit-mask": "string", Enter bit mask pattern string
                          "option-type": "enumeration" Match option
Options: 
                        },
                        "vrf": "string" Specify match VRF
                      },
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "class-name": "string", class name
                      : {List of VRFsPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "vrf-name": "string", VRF name
                            : {Helper addressesPUTPOSTDELETEGET
                              : [No descriptionPUTPOSTDELETEGET
                                {
                                  "server-address": "string", IPv4 address
                                  "gateway-address": "string" Gateway address
                                }
                              ]
                            }
                          }
                        ]
                      }
                    }
                  ]
                },
                "proxy-allow-move": [ null ], Allow dhcp subscriber move
                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option": "integer", No description
range: "1..255" 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },                : [Relay agent information optionPUTPOSTDELETEGET
                  {
                    "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                    "option": [ null ], No description
                    "remote-id-xr": [ null ], Insert Remote-id sub-option
                    "allow-untrusted": [ null ], Forward untrusted packets
                    "remote-id-suppress": [ null ], Suppress Remote ID
                    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                    "remote-id": "string", Enter remote-id value
                    "circuit-id": [ null ], Insert Circuit-id sub-option
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "vpn": [ null ], Insert VPN options
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                ]
              },              : {DHCP Snoop profilePUTPOSTDELETEGET
                : {DHCP Snoop profilePUTPOSTDELETEGET
                  "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                  "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                  : {Enter remote-id valuePUTPOSTDELETEGET
                    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                    "remote-id-value": "string" Enter remote-id value
                  },
                  "allow-untrusted": [ null ] Forward untrusted packets
                },
                "trusted": [ null ] Trusted sources
              },
              "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
              : {DHCP Base ProfilePUTPOSTDELETEGET
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {Enable the default profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile Name
                  "profile-mode": "integer" none 
                },                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option": "integer", No description
range: "1..255" 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchoption": "integer", Match options 
                          "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "def-matchoption": "integer" Match option 60 
                        }
                      ]
                    }
                  }
                ],                : {Insert match keywordPUTPOSTDELETEGET
                  : {Table of ModeClassPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "class-name": "string", class name
                        : {Enter proxy or server profilePUTPOSTDELETEGET
                          "profile-name": "string", Profile Name
                          "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                        }
                      }
                    ]
                  },                  : {Specify match optionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "opt60": "integer", none
                        : {Enter a profilePUTPOSTDELETEGET
                          "profile-name": "string", Profile Name
                          "profile-mode": "integer" none 
                        },
                        "opt60-hex-str": "string", Enter hex pattern string
                        "format": "integer" Set constant integer 
                      }
                    ]
                  }
                },                : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
                  "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
                  "remote-id": "string" Enter remote-id value
                },                : {Default match optionPUTPOSTDELETEGET
                  : {Enter server profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile Name
                    "default-mode": "enumeration" Specify mode
Options:
 server 
                  }
                }
              },              : {DHCP Server profilePUTPOSTDELETEGET
                : {NetBIOS node typePUTPOSTDELETEGET
                  "hybrid-node": "string", Set string
                  "mixed-node": "string", Set string
                  "hexadecimal": "string", Hexadecimal number
                  "broadcast-node": "string", Set string
                  "peer-to-peer-node": "string" Set string
                },
                "subnet-mask": "string", Configure Subnet Mask
                "domain-name": "string", Domain name
                "boot-filename": "string", Boot Filename
                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option-number": "integer", Option number 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },
                "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
                "next-server": "string", Configure the tftp-server IP to be used\nby the client
                : [Validate server ID checkPUTPOSTDELETEGET
                  {
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                ],
                "server-allow-move": [ null ], Allow dhcp subscriber move
                : {Specify limit leasePUTPOSTDELETEGET
                  "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
                  "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
                },
                "secure-arp": [ null ], Enable Secure Arp
                : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
                  "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
                },                : {DNS serversPUTPOSTDELETEGET
                  "dns-server": "string" DNS Server's IP address
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : [NonePUTPOSTDELETEGET
                  {
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
                  }
                ],                : {NetBIOS name serversPUTPOSTDELETEGET
                  "net-bios-name-server": "string" NetBIOSNameServer's IP address
                },
                "pool": "string", Specify the pool
                : [Change sessions configurationPUTPOSTDELETEGET
                  {                    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                      }
                    }
                  }
                ],                : {default routersPUTPOSTDELETEGET
                  "default-router": "string" Router's IP address
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {                    : {Table of OptionDefaultPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  }
                ],                : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                    "force-insert": [ null ] Set constant integer
                  }
                },                : {Validate Requested IP AddressPUTPOSTDELETEGET
                  "check": [ null ] specify requested-ip-address-check disable
                },                : {Table of ClassPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {                      : {NetBIOS name serversPUTPOSTDELETEGET
                        "net-bios-name-server": "string" NetBIOSNameServer's IP address
                      },                      : [Insert match keywordPUTPOSTDELETEGET
                        {
                          "l2-interface": "string", Specify match l2-interface
                          : {Table of Class-OptionPUTPOSTDELETEGET
                            : [No descriptionPUTPOSTDELETEGET
                              {
                                "pattern": "string", Enter hex pattern string
                                "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                                "bit-mask": "string" Enter bit mask pattern string
                              }
                            ]
                          },
                          "vrf": "string" Specify match VRF
                        }
                      ],                      : {default routersPUTPOSTDELETEGET
                        "default-router": "string" Router's IP address
                      },                      : [Table of OptionCodePUTPOSTDELETEGET
                        {                          : [DHCP option codePUTPOSTDELETEGET
                            {
                              "option-code": "integer", DHCP option code
range: "0..255" 
                              "hex-string": "string", Hexadecimal string
                              "ascii-string": "string", ASCII string
                              "ip-address": "string", Server's IP address
                              "force-insert": "integer" Set constant integer 
                            }
                          ]
                        }
                      ],
                      "subnet-mask": "string", Configure Subnet Mask
                      "boot-filename": "string", Boot Filename
                      "class-name": "string", class name
                      "domain-name": "string", Domain name
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "next-server": "string", Configure the tftp-server IP to be used\nby the client
                      : [NetBIOS node typePUTPOSTDELETEGET
                        {
                          "hybrid-node": "string", Set string
                          "mixed-node": "string", Set string
                          "hexadecimal": "string", Hexadecimal number
                          "broadcast-node": "string", Set string
                          "peer-to-peer-node": "string" Set string
                        }
                      ],                      : {DNS serversPUTPOSTDELETEGET
                        "dns-server": "string" DNS Server's IP address
                      },
                      "pool": "string", Specify the pool
                      : [leasePUTPOSTDELETEGET
                        {
                          "infinite": "string", Set string
                          "hours": "integer", Hours
range: "0..23"
units: "hour" 
                          "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                          "days": "integer" Days
range: "0..365"
units: "day" 
                        }
                      ]
                    }
                  ]
                },                : {Table of OptionCodePUTPOSTDELETEGET
                  : [DHCP option codePUTPOSTDELETEGET
                    {
                      "option-code": "integer", DHCP option code
range: "0..255" 
                      "hex-string": "string", Hexadecimal string
                      "ascii-string": "string", ASCII string
                      "ip-address": "string", Server's IP address
                      "force-insert": "integer" Set constant integer 
                    }
                  ]
                },                : [leasePUTPOSTDELETEGET
                  {
                    "infinite": "string", Set string
                    "hours": "integer", Hours
range: "0..23"
units: "hour" 
                    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                    "days": "integer" Days
range: "0..365"
units: "day" 
                  }
                ]
              }
            }
          ]
        },
        "profile-name": "string" Profile Name
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Delete operation of resource: profiles

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Retrieve operation of resource: profiles

200 OK

profiles_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPV4 Profile TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
          : [Specify modePUTPOSTDELETEGET
            {              : {DHCP Relay profilePUTPOSTDELETEGET
                : {GIADDR policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
                },                : {Broadcast Flag policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                },                : {VRF Helper AddressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper AddressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "gateway-address": "string", Gateway address
                            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                            "ip-address": "string" Server's IP address
                          }
                        ]
                      }
                    }
                  ]
                },
                "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
                : {Relay agent information optionPUTPOSTDELETEGET
                  "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                  "subscriber-id": "string", Subscriber ID
                  "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
                  : {Enter remote-id valuePUTPOSTDELETEGET
                    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                    "remote-id-value": "string" Enter remote-id value
                  },
                  "allow-untrusted": [ null ], Forward untrusted packets
                  "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                  "vpn": [ null ], Insert VPN options
                  "check": [ null ] specify requested-ip-address-check disable
                }
              },
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              : {DHCP proxy profilePUTPOSTDELETEGET
                : {Proxy limit leasePUTPOSTDELETEGET
                  "limit-lease-count": "string", Limit lease count
range: "1..240000" 
                  "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
                },                : {Specify broadcast flagPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
                },
                "secure-arp": [ null ], Enable Secure Arp
                : {Change sessions configurationPUTPOSTDELETEGET
                  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                    }
                  }
                },                : {Authentication Username formatingPUTPOSTDELETEGET
                  "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                  "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
                },                : {Specify gateway address policyPUTPOSTDELETEGET
                  "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
                },                : {Insert match keywordPUTPOSTDELETEGET
                  : {Table of OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                        "def-matchoption": "integer" Match option 60 
                      }
                    ]
                  },                  : {Table of OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "pattern": "string", Enter hex pattern string
                        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                        "matchoption": "integer", Match options 
                        "format": "integer" Set constant integer 
                      }
                    ]
                  }
                },                : {DHCPv4 lease proxyPUTPOSTDELETEGET
                  "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
                  "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
                },                : {List of VRFsPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper addressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "server-address": "string", IPv4 address
                            "gateway-address": "string" Gateway address
                          }
                        ]
                      }
                    }
                  ]
                },
                "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {DHCP class tablePUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {                      : {Match optionPUTPOSTDELETEGET
                        : {Match optionPUTPOSTDELETEGET
                          "pattern": "string", Enter hex pattern string
                          "bit-mask": "string", Enter bit mask pattern string
                          "option-type": "enumeration" Match option
Options: 
                        },
                        "vrf": "string" Specify match VRF
                      },
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "class-name": "string", class name
                      : {List of VRFsPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "vrf-name": "string", VRF name
                            : {Helper addressesPUTPOSTDELETEGET
                              : [No descriptionPUTPOSTDELETEGET
                                {
                                  "server-address": "string", IPv4 address
                                  "gateway-address": "string" Gateway address
                                }
                              ]
                            }
                          }
                        ]
                      }
                    }
                  ]
                },
                "proxy-allow-move": [ null ], Allow dhcp subscriber move
                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option": "integer", No description
range: "1..255" 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },                : [Relay agent information optionPUTPOSTDELETEGET
                  {
                    "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                    "option": [ null ], No description
                    "remote-id-xr": [ null ], Insert Remote-id sub-option
                    "allow-untrusted": [ null ], Forward untrusted packets
                    "remote-id-suppress": [ null ], Suppress Remote ID
                    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                    "remote-id": "string", Enter remote-id value
                    "circuit-id": [ null ], Insert Circuit-id sub-option
                    "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                    "vpn": [ null ], Insert VPN options
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                ]
              },              : {DHCP Snoop profilePUTPOSTDELETEGET
                : {DHCP Snoop profilePUTPOSTDELETEGET
                  "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                  "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
                  : {Enter remote-id valuePUTPOSTDELETEGET
                    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                    "remote-id-value": "string" Enter remote-id value
                  },
                  "allow-untrusted": [ null ] Forward untrusted packets
                },
                "trusted": [ null ] Trusted sources
              },
              "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
              : {DHCP Base ProfilePUTPOSTDELETEGET
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : {Enable the default profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile Name
                  "profile-mode": "integer" none 
                },                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option": "integer", No description
range: "1..255" 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchoption": "integer", Match options 
                          "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "def-matchoption": "integer" Match option 60 
                        }
                      ]
                    }
                  }
                ],                : {Insert match keywordPUTPOSTDELETEGET
                  : {Table of ModeClassPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "class-name": "string", class name
                        : {Enter proxy or server profilePUTPOSTDELETEGET
                          "profile-name": "string", Profile Name
                          "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                        }
                      }
                    ]
                  },                  : {Specify match optionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "opt60": "integer", none
                        : {Enter a profilePUTPOSTDELETEGET
                          "profile-name": "string", Profile Name
                          "profile-mode": "integer" none 
                        },
                        "opt60-hex-str": "string", Enter hex pattern string
                        "format": "integer" Set constant integer 
                      }
                    ]
                  }
                },                : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
                  "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
                  "remote-id": "string" Enter remote-id value
                },                : {Default match optionPUTPOSTDELETEGET
                  : {Enter server profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile Name
                    "default-mode": "enumeration" Specify mode
Options:
 server 
                  }
                }
              },              : {DHCP Server profilePUTPOSTDELETEGET
                : {NetBIOS node typePUTPOSTDELETEGET
                  "hybrid-node": "string", Set string
                  "mixed-node": "string", Set string
                  "hexadecimal": "string", Hexadecimal number
                  "broadcast-node": "string", Set string
                  "peer-to-peer-node": "string" Set string
                },
                "subnet-mask": "string", Configure Subnet Mask
                "domain-name": "string", Domain name
                "boot-filename": "string", Boot Filename
                : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
                  : {option typePUTPOSTDELETEGET
                    : {List of optionsPUTPOSTDELETEGET
                      "option-number": "integer", Option number 
                      "option-all": "integer" Set constant integer 
                    }
                  }
                },
                "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
                "next-server": "string", Configure the tftp-server IP to be used\nby the client
                : [Validate server ID checkPUTPOSTDELETEGET
                  {
                    "check": [ null ] specify requested-ip-address-check disable
                  }
                ],
                "server-allow-move": [ null ], Allow dhcp subscriber move
                : {Specify limit leasePUTPOSTDELETEGET
                  "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
                  "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
                },
                "secure-arp": [ null ], Enable Secure Arp
                : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
                  "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
                },                : {DNS serversPUTPOSTDELETEGET
                  "dns-server": "string" DNS Server's IP address
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                : [NonePUTPOSTDELETEGET
                  {
                    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
                  }
                ],                : {NetBIOS name serversPUTPOSTDELETEGET
                  "net-bios-name-server": "string" NetBIOSNameServer's IP address
                },
                "pool": "string", Specify the pool
                : [Change sessions configurationPUTPOSTDELETEGET
                  {                    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                      }
                    }
                  }
                ],                : {default routersPUTPOSTDELETEGET
                  "default-router": "string" Router's IP address
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {                    : {Table of OptionDefaultPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                        }
                      ]
                    },                    : {Table of OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          "format": "integer" Set constant integer 
                        }
                      ]
                    }
                  }
                ],                : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                    "force-insert": [ null ] Set constant integer
                  }
                },                : {Validate Requested IP AddressPUTPOSTDELETEGET
                  "check": [ null ] specify requested-ip-address-check disable
                },                : {Table of ClassPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {                      : {NetBIOS name serversPUTPOSTDELETEGET
                        "net-bios-name-server": "string" NetBIOSNameServer's IP address
                      },                      : [Insert match keywordPUTPOSTDELETEGET
                        {
                          "l2-interface": "string", Specify match l2-interface
                          : {Table of Class-OptionPUTPOSTDELETEGET
                            : [No descriptionPUTPOSTDELETEGET
                              {
                                "pattern": "string", Enter hex pattern string
                                "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                                "bit-mask": "string" Enter bit mask pattern string
                              }
                            ]
                          },
                          "vrf": "string" Specify match VRF
                        }
                      ],                      : {default routersPUTPOSTDELETEGET
                        "default-router": "string" Router's IP address
                      },                      : [Table of OptionCodePUTPOSTDELETEGET
                        {                          : [DHCP option codePUTPOSTDELETEGET
                            {
                              "option-code": "integer", DHCP option code
range: "0..255" 
                              "hex-string": "string", Hexadecimal string
                              "ascii-string": "string", ASCII string
                              "ip-address": "string", Server's IP address
                              "force-insert": "integer" Set constant integer 
                            }
                          ]
                        }
                      ],
                      "subnet-mask": "string", Configure Subnet Mask
                      "boot-filename": "string", Boot Filename
                      "class-name": "string", class name
                      "domain-name": "string", Domain name
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "next-server": "string", Configure the tftp-server IP to be used\nby the client
                      : [NetBIOS node typePUTPOSTDELETEGET
                        {
                          "hybrid-node": "string", Set string
                          "mixed-node": "string", Set string
                          "hexadecimal": "string", Hexadecimal number
                          "broadcast-node": "string", Set string
                          "peer-to-peer-node": "string" Set string
                        }
                      ],                      : {DNS serversPUTPOSTDELETEGET
                        "dns-server": "string" DNS Server's IP address
                      },
                      "pool": "string", Specify the pool
                      : [leasePUTPOSTDELETEGET
                        {
                          "infinite": "string", Set string
                          "hours": "integer", Hours
range: "0..23"
units: "hour" 
                          "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                          "days": "integer" Days
range: "0..365"
units: "day" 
                        }
                      ]
                    }
                  ]
                },                : {Table of OptionCodePUTPOSTDELETEGET
                  : [DHCP option codePUTPOSTDELETEGET
                    {
                      "option-code": "integer", DHCP option code
range: "0..255" 
                      "hex-string": "string", Hexadecimal string
                      "ascii-string": "string", ASCII string
                      "ip-address": "string", Server's IP address
                      "force-insert": "integer" Set constant integer 
                    }
                  ]
                },                : [leasePUTPOSTDELETEGET
                  {
                    "infinite": "string", Set string
                    "hours": "integer", Hours
range: "0..23"
units: "hour" 
                    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                    "days": "integer" Days
range: "0..365"
units: "day" 
                  }
                ]
              }
            }
          ]
        },
        "profile-name": "string" Profile Name
      }
    ]
  }
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Update operation of resource: profile

profile_schema

profilebody object

profile-name: string

in path

ID of profile-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
      : [Specify modePUTPOSTDELETEGET
        {          : {DHCP Relay profilePUTPOSTDELETEGET
            : {GIADDR policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
            },            : {Broadcast Flag policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
            },            : {VRF Helper AddressesPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "vrf-name": "string", VRF name
                  : {Helper AddressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "gateway-address": "string", Gateway address
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "ip-address": "string" Server's IP address
                      }
                    ]
                  }
                }
              ]
            },
            "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
            : {Relay agent information optionPUTPOSTDELETEGET
              "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
              "subscriber-id": "string", Subscriber ID
              "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
              : {Enter remote-id valuePUTPOSTDELETEGET
                "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                "remote-id-value": "string" Enter remote-id value
              },
              "allow-untrusted": [ null ], Forward untrusted packets
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "vpn": [ null ], Insert VPN options
              "check": [ null ] specify requested-ip-address-check disable
            }
          },
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {DHCP proxy profilePUTPOSTDELETEGET
            : {Proxy limit leasePUTPOSTDELETEGET
              "limit-lease-count": "string", Limit lease count
range: "1..240000" 
              "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
            },            : {Specify broadcast flagPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
            },
            "secure-arp": [ null ], Enable Secure Arp
            : {Change sessions configurationPUTPOSTDELETEGET
              : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                  "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                  "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                  "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                }
              }
            },            : {Authentication Username formatingPUTPOSTDELETEGET
              "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
              "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
            },            : {Specify gateway address policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
            },            : {Insert match keywordPUTPOSTDELETEGET
              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                    "def-matchoption": "integer" Match option 60 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                    "matchoption": "integer", Match options 
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            },            : {DHCPv4 lease proxyPUTPOSTDELETEGET
              "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
              "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
            },            : {List of VRFsPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "vrf-name": "string", VRF name
                  : {Helper addressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "server-address": "string", IPv4 address
                        "gateway-address": "string" Gateway address
                      }
                    ]
                  }
                }
              ]
            },
            "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : {DHCP class tablePUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {                  : {Match optionPUTPOSTDELETEGET
                    : {Match optionPUTPOSTDELETEGET
                      "pattern": "string", Enter hex pattern string
                      "bit-mask": "string", Enter bit mask pattern string
                      "option-type": "enumeration" Match option
Options: 
                    },
                    "vrf": "string" Specify match VRF
                  },
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  "class-name": "string", class name
                  : {List of VRFsPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper addressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "server-address": "string", IPv4 address
                              "gateway-address": "string" Gateway address
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              ]
            },
            "proxy-allow-move": [ null ], Allow dhcp subscriber move
            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option": "integer", No description
range: "1..255" 
                  "option-all": "integer" Set constant integer 
                }
              }
            },            : [Relay agent information optionPUTPOSTDELETEGET
              {
                "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                "option": [ null ], No description
                "remote-id-xr": [ null ], Insert Remote-id sub-option
                "allow-untrusted": [ null ], Forward untrusted packets
                "remote-id-suppress": [ null ], Suppress Remote ID
                "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                "remote-id": "string", Enter remote-id value
                "circuit-id": [ null ], Insert Circuit-id sub-option
                "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                "vpn": [ null ], Insert VPN options
                "check": [ null ] specify requested-ip-address-check disable
              }
            ]
          },          : {DHCP Snoop profilePUTPOSTDELETEGET
            : {DHCP Snoop profilePUTPOSTDELETEGET
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
              : {Enter remote-id valuePUTPOSTDELETEGET
                "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                "remote-id-value": "string" Enter remote-id value
              },
              "allow-untrusted": [ null ] Forward untrusted packets
            },
            "trusted": [ null ] Trusted sources
          },
          "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
          : {DHCP Base ProfilePUTPOSTDELETEGET
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : {Enable the default profilePUTPOSTDELETEGET
              "profile-name": "string", Profile Name
              "profile-mode": "integer" none 
            },            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option": "integer", No description
range: "1..255" 
                  "option-all": "integer" Set constant integer 
                }
              }
            },            : [Insert match keywordPUTPOSTDELETEGET
              {                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "pattern": "string", Enter hex pattern string
                      "matchoption": "integer", Match options 
                      "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                      "format": "integer" Set constant integer 
                    }
                  ]
                },                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "def-matchoption": "integer" Match option 60 
                    }
                  ]
                }
              }
            ],            : {Insert match keywordPUTPOSTDELETEGET
              : {Table of ModeClassPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "class-name": "string", class name
                    : {Enter proxy or server profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                    }
                  }
                ]
              },              : {Specify match optionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "opt60": "integer", none
                    : {Enter a profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "profile-mode": "integer" none 
                    },
                    "opt60-hex-str": "string", Enter hex pattern string
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            },            : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
              "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
              "remote-id": "string" Enter remote-id value
            },            : {Default match optionPUTPOSTDELETEGET
              : {Enter server profilePUTPOSTDELETEGET
                "profile-name": "string", Profile Name
                "default-mode": "enumeration" Specify mode
Options:
 server 
              }
            }
          },          : {DHCP Server profilePUTPOSTDELETEGET
            : {NetBIOS node typePUTPOSTDELETEGET
              "hybrid-node": "string", Set string
              "mixed-node": "string", Set string
              "hexadecimal": "string", Hexadecimal number
              "broadcast-node": "string", Set string
              "peer-to-peer-node": "string" Set string
            },
            "subnet-mask": "string", Configure Subnet Mask
            "domain-name": "string", Domain name
            "boot-filename": "string", Boot Filename
            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option-number": "integer", Option number 
                  "option-all": "integer" Set constant integer 
                }
              }
            },
            "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
            "next-server": "string", Configure the tftp-server IP to be used\nby the client
            : [Validate server ID checkPUTPOSTDELETEGET
              {
                "check": [ null ] specify requested-ip-address-check disable
              }
            ],
            "server-allow-move": [ null ], Allow dhcp subscriber move
            : {Specify limit leasePUTPOSTDELETEGET
              "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
              "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
            },
            "secure-arp": [ null ], Enable Secure Arp
            : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
              "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
            },            : {DNS serversPUTPOSTDELETEGET
              "dns-server": "string" DNS Server's IP address
            },
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : [NonePUTPOSTDELETEGET
              {
                "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
              }
            ],            : {NetBIOS name serversPUTPOSTDELETEGET
              "net-bios-name-server": "string" NetBIOSNameServer's IP address
            },
            "pool": "string", Specify the pool
            : [Change sessions configurationPUTPOSTDELETEGET
              {                : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                  }
                }
              }
            ],            : {default routersPUTPOSTDELETEGET
              "default-router": "string" Router's IP address
            },            : [Insert match keywordPUTPOSTDELETEGET
              {                : {Table of OptionDefaultPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    }
                  ]
                },                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "pattern": "string", Enter hex pattern string
                      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                      "format": "integer" Set constant integer 
                    }
                  ]
                }
              }
            ],            : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
              : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                "force-insert": [ null ] Set constant integer
              }
            },            : {Validate Requested IP AddressPUTPOSTDELETEGET
              "check": [ null ] specify requested-ip-address-check disable
            },            : {Table of ClassPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {                  : {NetBIOS name serversPUTPOSTDELETEGET
                    "net-bios-name-server": "string" NetBIOSNameServer's IP address
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {
                      "l2-interface": "string", Specify match l2-interface
                      : {Table of Class-OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                            "bit-mask": "string" Enter bit mask pattern string
                          }
                        ]
                      },
                      "vrf": "string" Specify match VRF
                    }
                  ],                  : {default routersPUTPOSTDELETEGET
                    "default-router": "string" Router's IP address
                  },                  : [Table of OptionCodePUTPOSTDELETEGET
                    {                      : [DHCP option codePUTPOSTDELETEGET
                        {
                          "option-code": "integer", DHCP option code
range: "0..255" 
                          "hex-string": "string", Hexadecimal string
                          "ascii-string": "string", ASCII string
                          "ip-address": "string", Server's IP address
                          "force-insert": "integer" Set constant integer 
                        }
                      ]
                    }
                  ],
                  "subnet-mask": "string", Configure Subnet Mask
                  "boot-filename": "string", Boot Filename
                  "class-name": "string", class name
                  "domain-name": "string", Domain name
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  "next-server": "string", Configure the tftp-server IP to be used\nby the client
                  : [NetBIOS node typePUTPOSTDELETEGET
                    {
                      "hybrid-node": "string", Set string
                      "mixed-node": "string", Set string
                      "hexadecimal": "string", Hexadecimal number
                      "broadcast-node": "string", Set string
                      "peer-to-peer-node": "string" Set string
                    }
                  ],                  : {DNS serversPUTPOSTDELETEGET
                    "dns-server": "string" DNS Server's IP address
                  },
                  "pool": "string", Specify the pool
                  : [leasePUTPOSTDELETEGET
                    {
                      "infinite": "string", Set string
                      "hours": "integer", Hours
range: "0..23"
units: "hour" 
                      "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                      "days": "integer" Days
range: "0..365"
units: "day" 
                    }
                  ]
                }
              ]
            },            : {Table of OptionCodePUTPOSTDELETEGET
              : [DHCP option codePUTPOSTDELETEGET
                {
                  "option-code": "integer", DHCP option code
range: "0..255" 
                  "hex-string": "string", Hexadecimal string
                  "ascii-string": "string", ASCII string
                  "ip-address": "string", Server's IP address
                  "force-insert": "integer" Set constant integer 
                }
              ]
            },            : [leasePUTPOSTDELETEGET
              {
                "infinite": "string", Set string
                "hours": "integer", Hours
range: "0..23"
units: "hour" 
                "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                "days": "integer" Days
range: "0..365"
units: "day" 
              }
            ]
          }
        }
      ]
    },
    "profile-name": "string" Profile Name
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Create operation of resource: profile

profile_schema

profilebody object

profile-name: string

in path

ID of profile-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
      : [Specify modePUTPOSTDELETEGET
        {          : {DHCP Relay profilePUTPOSTDELETEGET
            : {GIADDR policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
            },            : {Broadcast Flag policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
            },            : {VRF Helper AddressesPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "vrf-name": "string", VRF name
                  : {Helper AddressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "gateway-address": "string", Gateway address
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "ip-address": "string" Server's IP address
                      }
                    ]
                  }
                }
              ]
            },
            "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
            : {Relay agent information optionPUTPOSTDELETEGET
              "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
              "subscriber-id": "string", Subscriber ID
              "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
              : {Enter remote-id valuePUTPOSTDELETEGET
                "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                "remote-id-value": "string" Enter remote-id value
              },
              "allow-untrusted": [ null ], Forward untrusted packets
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "vpn": [ null ], Insert VPN options
              "check": [ null ] specify requested-ip-address-check disable
            }
          },
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {DHCP proxy profilePUTPOSTDELETEGET
            : {Proxy limit leasePUTPOSTDELETEGET
              "limit-lease-count": "string", Limit lease count
range: "1..240000" 
              "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
            },            : {Specify broadcast flagPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
            },
            "secure-arp": [ null ], Enable Secure Arp
            : {Change sessions configurationPUTPOSTDELETEGET
              : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                  "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                  "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                  "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                }
              }
            },            : {Authentication Username formatingPUTPOSTDELETEGET
              "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
              "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
            },            : {Specify gateway address policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
            },            : {Insert match keywordPUTPOSTDELETEGET
              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                    "def-matchoption": "integer" Match option 60 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                    "matchoption": "integer", Match options 
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            },            : {DHCPv4 lease proxyPUTPOSTDELETEGET
              "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
              "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
            },            : {List of VRFsPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "vrf-name": "string", VRF name
                  : {Helper addressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "server-address": "string", IPv4 address
                        "gateway-address": "string" Gateway address
                      }
                    ]
                  }
                }
              ]
            },
            "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : {DHCP class tablePUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {                  : {Match optionPUTPOSTDELETEGET
                    : {Match optionPUTPOSTDELETEGET
                      "pattern": "string", Enter hex pattern string
                      "bit-mask": "string", Enter bit mask pattern string
                      "option-type": "enumeration" Match option
Options: 
                    },
                    "vrf": "string" Specify match VRF
                  },
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  "class-name": "string", class name
                  : {List of VRFsPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper addressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "server-address": "string", IPv4 address
                              "gateway-address": "string" Gateway address
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              ]
            },
            "proxy-allow-move": [ null ], Allow dhcp subscriber move
            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option": "integer", No description
range: "1..255" 
                  "option-all": "integer" Set constant integer 
                }
              }
            },            : [Relay agent information optionPUTPOSTDELETEGET
              {
                "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                "option": [ null ], No description
                "remote-id-xr": [ null ], Insert Remote-id sub-option
                "allow-untrusted": [ null ], Forward untrusted packets
                "remote-id-suppress": [ null ], Suppress Remote ID
                "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                "remote-id": "string", Enter remote-id value
                "circuit-id": [ null ], Insert Circuit-id sub-option
                "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                "vpn": [ null ], Insert VPN options
                "check": [ null ] specify requested-ip-address-check disable
              }
            ]
          },          : {DHCP Snoop profilePUTPOSTDELETEGET
            : {DHCP Snoop profilePUTPOSTDELETEGET
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
              : {Enter remote-id valuePUTPOSTDELETEGET
                "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                "remote-id-value": "string" Enter remote-id value
              },
              "allow-untrusted": [ null ] Forward untrusted packets
            },
            "trusted": [ null ] Trusted sources
          },
          "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
          : {DHCP Base ProfilePUTPOSTDELETEGET
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : {Enable the default profilePUTPOSTDELETEGET
              "profile-name": "string", Profile Name
              "profile-mode": "integer" none 
            },            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option": "integer", No description
range: "1..255" 
                  "option-all": "integer" Set constant integer 
                }
              }
            },            : [Insert match keywordPUTPOSTDELETEGET
              {                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "pattern": "string", Enter hex pattern string
                      "matchoption": "integer", Match options 
                      "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                      "format": "integer" Set constant integer 
                    }
                  ]
                },                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "def-matchoption": "integer" Match option 60 
                    }
                  ]
                }
              }
            ],            : {Insert match keywordPUTPOSTDELETEGET
              : {Table of ModeClassPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "class-name": "string", class name
                    : {Enter proxy or server profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                    }
                  }
                ]
              },              : {Specify match optionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "opt60": "integer", none
                    : {Enter a profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "profile-mode": "integer" none 
                    },
                    "opt60-hex-str": "string", Enter hex pattern string
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            },            : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
              "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
              "remote-id": "string" Enter remote-id value
            },            : {Default match optionPUTPOSTDELETEGET
              : {Enter server profilePUTPOSTDELETEGET
                "profile-name": "string", Profile Name
                "default-mode": "enumeration" Specify mode
Options:
 server 
              }
            }
          },          : {DHCP Server profilePUTPOSTDELETEGET
            : {NetBIOS node typePUTPOSTDELETEGET
              "hybrid-node": "string", Set string
              "mixed-node": "string", Set string
              "hexadecimal": "string", Hexadecimal number
              "broadcast-node": "string", Set string
              "peer-to-peer-node": "string" Set string
            },
            "subnet-mask": "string", Configure Subnet Mask
            "domain-name": "string", Domain name
            "boot-filename": "string", Boot Filename
            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option-number": "integer", Option number 
                  "option-all": "integer" Set constant integer 
                }
              }
            },
            "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
            "next-server": "string", Configure the tftp-server IP to be used\nby the client
            : [Validate server ID checkPUTPOSTDELETEGET
              {
                "check": [ null ] specify requested-ip-address-check disable
              }
            ],
            "server-allow-move": [ null ], Allow dhcp subscriber move
            : {Specify limit leasePUTPOSTDELETEGET
              "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
              "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
            },
            "secure-arp": [ null ], Enable Secure Arp
            : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
              "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
            },            : {DNS serversPUTPOSTDELETEGET
              "dns-server": "string" DNS Server's IP address
            },
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : [NonePUTPOSTDELETEGET
              {
                "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
              }
            ],            : {NetBIOS name serversPUTPOSTDELETEGET
              "net-bios-name-server": "string" NetBIOSNameServer's IP address
            },
            "pool": "string", Specify the pool
            : [Change sessions configurationPUTPOSTDELETEGET
              {                : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                  }
                }
              }
            ],            : {default routersPUTPOSTDELETEGET
              "default-router": "string" Router's IP address
            },            : [Insert match keywordPUTPOSTDELETEGET
              {                : {Table of OptionDefaultPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    }
                  ]
                },                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "pattern": "string", Enter hex pattern string
                      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                      "format": "integer" Set constant integer 
                    }
                  ]
                }
              }
            ],            : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
              : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                "force-insert": [ null ] Set constant integer
              }
            },            : {Validate Requested IP AddressPUTPOSTDELETEGET
              "check": [ null ] specify requested-ip-address-check disable
            },            : {Table of ClassPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {                  : {NetBIOS name serversPUTPOSTDELETEGET
                    "net-bios-name-server": "string" NetBIOSNameServer's IP address
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {
                      "l2-interface": "string", Specify match l2-interface
                      : {Table of Class-OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                            "bit-mask": "string" Enter bit mask pattern string
                          }
                        ]
                      },
                      "vrf": "string" Specify match VRF
                    }
                  ],                  : {default routersPUTPOSTDELETEGET
                    "default-router": "string" Router's IP address
                  },                  : [Table of OptionCodePUTPOSTDELETEGET
                    {                      : [DHCP option codePUTPOSTDELETEGET
                        {
                          "option-code": "integer", DHCP option code
range: "0..255" 
                          "hex-string": "string", Hexadecimal string
                          "ascii-string": "string", ASCII string
                          "ip-address": "string", Server's IP address
                          "force-insert": "integer" Set constant integer 
                        }
                      ]
                    }
                  ],
                  "subnet-mask": "string", Configure Subnet Mask
                  "boot-filename": "string", Boot Filename
                  "class-name": "string", class name
                  "domain-name": "string", Domain name
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  "next-server": "string", Configure the tftp-server IP to be used\nby the client
                  : [NetBIOS node typePUTPOSTDELETEGET
                    {
                      "hybrid-node": "string", Set string
                      "mixed-node": "string", Set string
                      "hexadecimal": "string", Hexadecimal number
                      "broadcast-node": "string", Set string
                      "peer-to-peer-node": "string" Set string
                    }
                  ],                  : {DNS serversPUTPOSTDELETEGET
                    "dns-server": "string" DNS Server's IP address
                  },
                  "pool": "string", Specify the pool
                  : [leasePUTPOSTDELETEGET
                    {
                      "infinite": "string", Set string
                      "hours": "integer", Hours
range: "0..23"
units: "hour" 
                      "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                      "days": "integer" Days
range: "0..365"
units: "day" 
                    }
                  ]
                }
              ]
            },            : {Table of OptionCodePUTPOSTDELETEGET
              : [DHCP option codePUTPOSTDELETEGET
                {
                  "option-code": "integer", DHCP option code
range: "0..255" 
                  "hex-string": "string", Hexadecimal string
                  "ascii-string": "string", ASCII string
                  "ip-address": "string", Server's IP address
                  "force-insert": "integer" Set constant integer 
                }
              ]
            },            : [leasePUTPOSTDELETEGET
              {
                "infinite": "string", Set string
                "hours": "integer", Hours
range: "0..23"
units: "hour" 
                "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                "days": "integer" Days
range: "0..365"
units: "day" 
              }
            ]
          }
        }
      ]
    },
    "profile-name": "string" Profile Name
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Delete operation of resource: profile

profile-name: string

in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Retrieve operation of resource: profile

profile-name: string

in path

ID of profile-name

200 OK

profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
      : [Specify modePUTPOSTDELETEGET
        {          : {DHCP Relay profilePUTPOSTDELETEGET
            : {GIADDR policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
            },            : {Broadcast Flag policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
            },            : {VRF Helper AddressesPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "vrf-name": "string", VRF name
                  : {Helper AddressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "gateway-address": "string", Gateway address
                        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                        "ip-address": "string" Server's IP address
                      }
                    ]
                  }
                }
              ]
            },
            "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
            : {Relay agent information optionPUTPOSTDELETEGET
              "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
              "subscriber-id": "string", Subscriber ID
              "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
              : {Enter remote-id valuePUTPOSTDELETEGET
                "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                "remote-id-value": "string" Enter remote-id value
              },
              "allow-untrusted": [ null ], Forward untrusted packets
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "vpn": [ null ], Insert VPN options
              "check": [ null ] specify requested-ip-address-check disable
            }
          },
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {DHCP proxy profilePUTPOSTDELETEGET
            : {Proxy limit leasePUTPOSTDELETEGET
              "limit-lease-count": "string", Limit lease count
range: "1..240000" 
              "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
            },            : {Specify broadcast flagPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
            },
            "secure-arp": [ null ], Enable Secure Arp
            : {Change sessions configurationPUTPOSTDELETEGET
              : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                  "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                  "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                  "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                }
              }
            },            : {Authentication Username formatingPUTPOSTDELETEGET
              "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
              "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
            },            : {Specify gateway address policyPUTPOSTDELETEGET
              "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
            },            : {Insert match keywordPUTPOSTDELETEGET
              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                    "def-matchoption": "integer" Match option 60 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                    "matchoption": "integer", Match options 
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            },            : {DHCPv4 lease proxyPUTPOSTDELETEGET
              "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
              "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
            },            : {List of VRFsPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "vrf-name": "string", VRF name
                  : {Helper addressesPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "server-address": "string", IPv4 address
                        "gateway-address": "string" Gateway address
                      }
                    ]
                  }
                }
              ]
            },
            "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : {DHCP class tablePUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {                  : {Match optionPUTPOSTDELETEGET
                    : {Match optionPUTPOSTDELETEGET
                      "pattern": "string", Enter hex pattern string
                      "bit-mask": "string", Enter bit mask pattern string
                      "option-type": "enumeration" Match option
Options: 
                    },
                    "vrf": "string" Specify match VRF
                  },
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  "class-name": "string", class name
                  : {List of VRFsPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "vrf-name": "string", VRF name
                        : {Helper addressesPUTPOSTDELETEGET
                          : [No descriptionPUTPOSTDELETEGET
                            {
                              "server-address": "string", IPv4 address
                              "gateway-address": "string" Gateway address
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              ]
            },
            "proxy-allow-move": [ null ], Allow dhcp subscriber move
            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option": "integer", No description
range: "1..255" 
                  "option-all": "integer" Set constant integer 
                }
              }
            },            : [Relay agent information optionPUTPOSTDELETEGET
              {
                "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
                "option": [ null ], No description
                "remote-id-xr": [ null ], Insert Remote-id sub-option
                "allow-untrusted": [ null ], Forward untrusted packets
                "remote-id-suppress": [ null ], Suppress Remote ID
                "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
                "remote-id": "string", Enter remote-id value
                "circuit-id": [ null ], Insert Circuit-id sub-option
                "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
                "vpn": [ null ], Insert VPN options
                "check": [ null ] specify requested-ip-address-check disable
              }
            ]
          },          : {DHCP Snoop profilePUTPOSTDELETEGET
            : {DHCP Snoop profilePUTPOSTDELETEGET
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
              : {Enter remote-id valuePUTPOSTDELETEGET
                "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
                "remote-id-value": "string" Enter remote-id value
              },
              "allow-untrusted": [ null ] Forward untrusted packets
            },
            "trusted": [ null ] Trusted sources
          },
          "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
          : {DHCP Base ProfilePUTPOSTDELETEGET
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : {Enable the default profilePUTPOSTDELETEGET
              "profile-name": "string", Profile Name
              "profile-mode": "integer" none 
            },            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option": "integer", No description
range: "1..255" 
                  "option-all": "integer" Set constant integer 
                }
              }
            },            : [Insert match keywordPUTPOSTDELETEGET
              {                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "pattern": "string", Enter hex pattern string
                      "matchoption": "integer", Match options 
                      "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                      "format": "integer" Set constant integer 
                    }
                  ]
                },                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "def-matchoption": "integer" Match option 60 
                    }
                  ]
                }
              }
            ],            : {Insert match keywordPUTPOSTDELETEGET
              : {Table of ModeClassPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "class-name": "string", class name
                    : {Enter proxy or server profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                    }
                  }
                ]
              },              : {Specify match optionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "opt60": "integer", none
                    : {Enter a profilePUTPOSTDELETEGET
                      "profile-name": "string", Profile Name
                      "profile-mode": "integer" none 
                    },
                    "opt60-hex-str": "string", Enter hex pattern string
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            },            : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
              "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
              "remote-id": "string" Enter remote-id value
            },            : {Default match optionPUTPOSTDELETEGET
              : {Enter server profilePUTPOSTDELETEGET
                "profile-name": "string", Profile Name
                "default-mode": "enumeration" Specify mode
Options:
 server 
              }
            }
          },          : {DHCP Server profilePUTPOSTDELETEGET
            : {NetBIOS node typePUTPOSTDELETEGET
              "hybrid-node": "string", Set string
              "mixed-node": "string", Set string
              "hexadecimal": "string", Hexadecimal number
              "broadcast-node": "string", Set string
              "peer-to-peer-node": "string" Set string
            },
            "subnet-mask": "string", Configure Subnet Mask
            "domain-name": "string", Domain name
            "boot-filename": "string", Boot Filename
            : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
              : {option typePUTPOSTDELETEGET
                : {List of optionsPUTPOSTDELETEGET
                  "option-number": "integer", Option number 
                  "option-all": "integer" Set constant integer 
                }
              }
            },
            "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
            "next-server": "string", Configure the tftp-server IP to be used\nby the client
            : [Validate server ID checkPUTPOSTDELETEGET
              {
                "check": [ null ] specify requested-ip-address-check disable
              }
            ],
            "server-allow-move": [ null ], Allow dhcp subscriber move
            : {Specify limit leasePUTPOSTDELETEGET
              "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
              "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
            },
            "secure-arp": [ null ], Enable Secure Arp
            : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
              "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
            },            : {DNS serversPUTPOSTDELETEGET
              "dns-server": "string" DNS Server's IP address
            },
            "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
            : [NonePUTPOSTDELETEGET
              {
                "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
              }
            ],            : {NetBIOS name serversPUTPOSTDELETEGET
              "net-bios-name-server": "string" NetBIOSNameServer's IP address
            },
            "pool": "string", Specify the pool
            : [Change sessions configurationPUTPOSTDELETEGET
              {                : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                  }
                }
              }
            ],            : {default routersPUTPOSTDELETEGET
              "default-router": "string" Router's IP address
            },            : [Insert match keywordPUTPOSTDELETEGET
              {                : {Table of OptionDefaultPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    }
                  ]
                },                : {Table of OptionPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "pattern": "string", Enter hex pattern string
                      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                      "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                      "format": "integer" Set constant integer 
                    }
                  ]
                }
              }
            ],            : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
              : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
                "force-insert": [ null ] Set constant integer
              }
            },            : {Validate Requested IP AddressPUTPOSTDELETEGET
              "check": [ null ] specify requested-ip-address-check disable
            },            : {Table of ClassPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {                  : {NetBIOS name serversPUTPOSTDELETEGET
                    "net-bios-name-server": "string" NetBIOSNameServer's IP address
                  },                  : [Insert match keywordPUTPOSTDELETEGET
                    {
                      "l2-interface": "string", Specify match l2-interface
                      : {Table of Class-OptionPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "pattern": "string", Enter hex pattern string
                            "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                            "bit-mask": "string" Enter bit mask pattern string
                          }
                        ]
                      },
                      "vrf": "string" Specify match VRF
                    }
                  ],                  : {default routersPUTPOSTDELETEGET
                    "default-router": "string" Router's IP address
                  },                  : [Table of OptionCodePUTPOSTDELETEGET
                    {                      : [DHCP option codePUTPOSTDELETEGET
                        {
                          "option-code": "integer", DHCP option code
range: "0..255" 
                          "hex-string": "string", Hexadecimal string
                          "ascii-string": "string", ASCII string
                          "ip-address": "string", Server's IP address
                          "force-insert": "integer" Set constant integer 
                        }
                      ]
                    }
                  ],
                  "subnet-mask": "string", Configure Subnet Mask
                  "boot-filename": "string", Boot Filename
                  "class-name": "string", class name
                  "domain-name": "string", Domain name
                  "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                  "next-server": "string", Configure the tftp-server IP to be used\nby the client
                  : [NetBIOS node typePUTPOSTDELETEGET
                    {
                      "hybrid-node": "string", Set string
                      "mixed-node": "string", Set string
                      "hexadecimal": "string", Hexadecimal number
                      "broadcast-node": "string", Set string
                      "peer-to-peer-node": "string" Set string
                    }
                  ],                  : {DNS serversPUTPOSTDELETEGET
                    "dns-server": "string" DNS Server's IP address
                  },
                  "pool": "string", Specify the pool
                  : [leasePUTPOSTDELETEGET
                    {
                      "infinite": "string", Set string
                      "hours": "integer", Hours
range: "0..23"
units: "hour" 
                      "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                      "days": "integer" Days
range: "0..365"
units: "day" 
                    }
                  ]
                }
              ]
            },            : {Table of OptionCodePUTPOSTDELETEGET
              : [DHCP option codePUTPOSTDELETEGET
                {
                  "option-code": "integer", DHCP option code
range: "0..255" 
                  "hex-string": "string", Hexadecimal string
                  "ascii-string": "string", ASCII string
                  "ip-address": "string", Server's IP address
                  "force-insert": "integer" Set constant integer 
                }
              ]
            },            : [leasePUTPOSTDELETEGET
              {
                "infinite": "string", Set string
                "hours": "integer", Hours
range: "0..23"
units: "hour" 
                "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                "days": "integer" Days
range: "0..365"
units: "day" 
              }
            ]
          }
        }
      ]
    },
    "profile-name": "string" Profile Name
  }
}

MODES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Update operation of resource: modes

modes_schema

modesbody object

profile-name: string

in path

ID of profile-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
    : [Specify modePUTPOSTDELETEGET
      {        : {DHCP Relay profilePUTPOSTDELETEGET
          : {GIADDR policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
          },          : {Broadcast Flag policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
          },          : {VRF Helper AddressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper AddressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "gateway-address": "string", Gateway address
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "ip-address": "string" Server's IP address
                    }
                  ]
                }
              }
            ]
          },
          "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
          : {Relay agent information optionPUTPOSTDELETEGET
            "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
            "subscriber-id": "string", Subscriber ID
            "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
            : {Enter remote-id valuePUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "remote-id-value": "string" Enter remote-id value
            },
            "allow-untrusted": [ null ], Forward untrusted packets
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "vpn": [ null ], Insert VPN options
            "check": [ null ] specify requested-ip-address-check disable
          }
        },
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {DHCP proxy profilePUTPOSTDELETEGET
          : {Proxy limit leasePUTPOSTDELETEGET
            "limit-lease-count": "string", Limit lease count
range: "1..240000" 
            "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
          },          : {Specify broadcast flagPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
          },
          "secure-arp": [ null ], Enable Secure Arp
          : {Change sessions configurationPUTPOSTDELETEGET
            : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
              : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
              }
            }
          },          : {Authentication Username formatingPUTPOSTDELETEGET
            "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
            "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
          },          : {Specify gateway address policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
          },          : {Insert match keywordPUTPOSTDELETEGET
            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                  "def-matchoption": "integer" Match option 60 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                  "matchoption": "integer", Match options 
                  "format": "integer" Set constant integer 
                }
              ]
            }
          },          : {DHCPv4 lease proxyPUTPOSTDELETEGET
            "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
            "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
          },          : {List of VRFsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper addressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "server-address": "string", IPv4 address
                      "gateway-address": "string" Gateway address
                    }
                  ]
                }
              }
            ]
          },
          "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {DHCP class tablePUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {                : {Match optionPUTPOSTDELETEGET
                  : {Match optionPUTPOSTDELETEGET
                    "pattern": "string", Enter hex pattern string
                    "bit-mask": "string", Enter bit mask pattern string
                    "option-type": "enumeration" Match option
Options: 
                  },
                  "vrf": "string" Specify match VRF
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                "class-name": "string", class name
                : {List of VRFsPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper addressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "server-address": "string", IPv4 address
                            "gateway-address": "string" Gateway address
                          }
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          },
          "proxy-allow-move": [ null ], Allow dhcp subscriber move
          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option": "integer", No description
range: "1..255" 
                "option-all": "integer" Set constant integer 
              }
            }
          },          : [Relay agent information optionPUTPOSTDELETEGET
            {
              "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
              "option": [ null ], No description
              "remote-id-xr": [ null ], Insert Remote-id sub-option
              "allow-untrusted": [ null ], Forward untrusted packets
              "remote-id-suppress": [ null ], Suppress Remote ID
              "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
              "remote-id": "string", Enter remote-id value
              "circuit-id": [ null ], Insert Circuit-id sub-option
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "vpn": [ null ], Insert VPN options
              "check": [ null ] specify requested-ip-address-check disable
            }
          ]
        },        : {DHCP Snoop profilePUTPOSTDELETEGET
          : {DHCP Snoop profilePUTPOSTDELETEGET
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
            : {Enter remote-id valuePUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "remote-id-value": "string" Enter remote-id value
            },
            "allow-untrusted": [ null ] Forward untrusted packets
          },
          "trusted": [ null ] Trusted sources
        },
        "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
        : {DHCP Base ProfilePUTPOSTDELETEGET
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {Enable the default profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "profile-mode": "integer" none 
          },          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option": "integer", No description
range: "1..255" 
                "option-all": "integer" Set constant integer 
              }
            }
          },          : [Insert match keywordPUTPOSTDELETEGET
            {              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchoption": "integer", Match options 
                    "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                    "format": "integer" Set constant integer 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "def-matchoption": "integer" Match option 60 
                  }
                ]
              }
            }
          ],          : {Insert match keywordPUTPOSTDELETEGET
            : {Table of ModeClassPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "class-name": "string", class name
                  : {Enter proxy or server profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile name
                    "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                  }
                }
              ]
            },            : {Specify match optionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "opt60": "integer", none
                  : {Enter a profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile name
                    "profile-mode": "integer" none 
                  },
                  "opt60-hex-str": "string", Enter hex pattern string
                  "format": "integer" Set constant integer 
                }
              ]
            }
          },          : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
            "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
            "remote-id": "string" Enter remote-id value
          },          : {Default match optionPUTPOSTDELETEGET
            : {Enter server profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "default-mode": "enumeration" Specify mode
Options:
 server 
            }
          }
        },        : {DHCP Server profilePUTPOSTDELETEGET
          : {NetBIOS node typePUTPOSTDELETEGET
            "hybrid-node": "string", Set string
            "mixed-node": "string", Set string
            "hexadecimal": "string", Hexadecimal number
            "broadcast-node": "string", Set string
            "peer-to-peer-node": "string" Set string
          },
          "subnet-mask": "string", Configure Subnet Mask
          "domain-name": "string", Domain name
          "boot-filename": "string", Boot Filename
          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option-number": "integer", Option number 
                "option-all": "integer" Set constant integer 
              }
            }
          },
          "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
          "next-server": "string", Configure the tftp-server IP to be used\nby the client
          : [Validate server ID checkPUTPOSTDELETEGET
            {
              "check": [ null ] specify requested-ip-address-check disable
            }
          ],
          "server-allow-move": [ null ], Allow dhcp subscriber move
          : {Specify limit leasePUTPOSTDELETEGET
            "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
            "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
          },
          "secure-arp": [ null ], Enable Secure Arp
          : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
            "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
          },          : {DNS serversPUTPOSTDELETEGET
            "dns-server": "string" DNS Server's IP address
          },
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : [NonePUTPOSTDELETEGET
            {
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
            }
          ],          : {NetBIOS name serversPUTPOSTDELETEGET
            "net-bios-name-server": "string" NetBIOSNameServer's IP address
          },
          "pool": "string", Specify the pool
          : [Change sessions configurationPUTPOSTDELETEGET
            {              : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                  "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                  "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                  "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                }
              }
            }
          ],          : {default routersPUTPOSTDELETEGET
            "default-router": "string" Router's IP address
          },          : [Insert match keywordPUTPOSTDELETEGET
            {              : {Table of OptionDefaultPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            }
          ],          : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
            : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
              "force-insert": [ null ] Set constant integer
            }
          },          : {Validate Requested IP AddressPUTPOSTDELETEGET
            "check": [ null ] specify requested-ip-address-check disable
          },          : {Table of ClassPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {                : {NetBIOS name serversPUTPOSTDELETEGET
                  "net-bios-name-server": "string" NetBIOSNameServer's IP address
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {
                    "l2-interface": "string", Specify match l2-interface
                    : {Table of Class-OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          "bit-mask": "string" Enter bit mask pattern string
                        }
                      ]
                    },
                    "vrf": "string" Specify match VRF
                  }
                ],                : {default routersPUTPOSTDELETEGET
                  "default-router": "string" Router's IP address
                },                : [Table of OptionCodePUTPOSTDELETEGET
                  {                    : [DHCP option codePUTPOSTDELETEGET
                      {
                        "option-code": "integer", DHCP option code
range: "0..255" 
                        "hex-string": "string", Hexadecimal string
                        "ascii-string": "string", ASCII string
                        "ip-address": "string", Server's IP address
                        "force-insert": "integer" Set constant integer 
                      }
                    ]
                  }
                ],
                "subnet-mask": "string", Configure Subnet Mask
                "boot-filename": "string", Boot Filename
                "class-name": "string", class name
                "domain-name": "string", Domain name
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                "next-server": "string", Configure the tftp-server IP to be used\nby the client
                : [NetBIOS node typePUTPOSTDELETEGET
                  {
                    "hybrid-node": "string", Set string
                    "mixed-node": "string", Set string
                    "hexadecimal": "string", Hexadecimal number
                    "broadcast-node": "string", Set string
                    "peer-to-peer-node": "string" Set string
                  }
                ],                : {DNS serversPUTPOSTDELETEGET
                  "dns-server": "string" DNS Server's IP address
                },
                "pool": "string", Specify the pool
                : [leasePUTPOSTDELETEGET
                  {
                    "infinite": "string", Set string
                    "hours": "integer", Hours
range: "0..23"
units: "hour" 
                    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                    "days": "integer" Days
range: "0..365"
units: "day" 
                  }
                ]
              }
            ]
          },          : {Table of OptionCodePUTPOSTDELETEGET
            : [DHCP option codePUTPOSTDELETEGET
              {
                "option-code": "integer", DHCP option code
range: "0..255" 
                "hex-string": "string", Hexadecimal string
                "ascii-string": "string", ASCII string
                "ip-address": "string", Server's IP address
                "force-insert": "integer" Set constant integer 
              }
            ]
          },          : [leasePUTPOSTDELETEGET
            {
              "infinite": "string", Set string
              "hours": "integer", Hours
range: "0..23"
units: "hour" 
              "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
              "days": "integer" Days
range: "0..365"
units: "day" 
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Create operation of resource: modes

modes_schema

modesbody object

profile-name: string

in path

ID of profile-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
    : [Specify modePUTPOSTDELETEGET
      {        : {DHCP Relay profilePUTPOSTDELETEGET
          : {GIADDR policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
          },          : {Broadcast Flag policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
          },          : {VRF Helper AddressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper AddressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "gateway-address": "string", Gateway address
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "ip-address": "string" Server's IP address
                    }
                  ]
                }
              }
            ]
          },
          "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
          : {Relay agent information optionPUTPOSTDELETEGET
            "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
            "subscriber-id": "string", Subscriber ID
            "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
            : {Enter remote-id valuePUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "remote-id-value": "string" Enter remote-id value
            },
            "allow-untrusted": [ null ], Forward untrusted packets
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "vpn": [ null ], Insert VPN options
            "check": [ null ] specify requested-ip-address-check disable
          }
        },
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {DHCP proxy profilePUTPOSTDELETEGET
          : {Proxy limit leasePUTPOSTDELETEGET
            "limit-lease-count": "string", Limit lease count
range: "1..240000" 
            "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
          },          : {Specify broadcast flagPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
          },
          "secure-arp": [ null ], Enable Secure Arp
          : {Change sessions configurationPUTPOSTDELETEGET
            : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
              : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
              }
            }
          },          : {Authentication Username formatingPUTPOSTDELETEGET
            "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
            "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
          },          : {Specify gateway address policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
          },          : {Insert match keywordPUTPOSTDELETEGET
            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                  "def-matchoption": "integer" Match option 60 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                  "matchoption": "integer", Match options 
                  "format": "integer" Set constant integer 
                }
              ]
            }
          },          : {DHCPv4 lease proxyPUTPOSTDELETEGET
            "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
            "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
          },          : {List of VRFsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper addressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "server-address": "string", IPv4 address
                      "gateway-address": "string" Gateway address
                    }
                  ]
                }
              }
            ]
          },
          "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {DHCP class tablePUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {                : {Match optionPUTPOSTDELETEGET
                  : {Match optionPUTPOSTDELETEGET
                    "pattern": "string", Enter hex pattern string
                    "bit-mask": "string", Enter bit mask pattern string
                    "option-type": "enumeration" Match option
Options: 
                  },
                  "vrf": "string" Specify match VRF
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                "class-name": "string", class name
                : {List of VRFsPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper addressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "server-address": "string", IPv4 address
                            "gateway-address": "string" Gateway address
                          }
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          },
          "proxy-allow-move": [ null ], Allow dhcp subscriber move
          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option": "integer", No description
range: "1..255" 
                "option-all": "integer" Set constant integer 
              }
            }
          },          : [Relay agent information optionPUTPOSTDELETEGET
            {
              "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
              "option": [ null ], No description
              "remote-id-xr": [ null ], Insert Remote-id sub-option
              "allow-untrusted": [ null ], Forward untrusted packets
              "remote-id-suppress": [ null ], Suppress Remote ID
              "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
              "remote-id": "string", Enter remote-id value
              "circuit-id": [ null ], Insert Circuit-id sub-option
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "vpn": [ null ], Insert VPN options
              "check": [ null ] specify requested-ip-address-check disable
            }
          ]
        },        : {DHCP Snoop profilePUTPOSTDELETEGET
          : {DHCP Snoop profilePUTPOSTDELETEGET
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
            : {Enter remote-id valuePUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "remote-id-value": "string" Enter remote-id value
            },
            "allow-untrusted": [ null ] Forward untrusted packets
          },
          "trusted": [ null ] Trusted sources
        },
        "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
        : {DHCP Base ProfilePUTPOSTDELETEGET
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {Enable the default profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "profile-mode": "integer" none 
          },          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option": "integer", No description
range: "1..255" 
                "option-all": "integer" Set constant integer 
              }
            }
          },          : [Insert match keywordPUTPOSTDELETEGET
            {              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchoption": "integer", Match options 
                    "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                    "format": "integer" Set constant integer 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "def-matchoption": "integer" Match option 60 
                  }
                ]
              }
            }
          ],          : {Insert match keywordPUTPOSTDELETEGET
            : {Table of ModeClassPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "class-name": "string", class name
                  : {Enter proxy or server profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile name
                    "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                  }
                }
              ]
            },            : {Specify match optionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "opt60": "integer", none
                  : {Enter a profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile name
                    "profile-mode": "integer" none 
                  },
                  "opt60-hex-str": "string", Enter hex pattern string
                  "format": "integer" Set constant integer 
                }
              ]
            }
          },          : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
            "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
            "remote-id": "string" Enter remote-id value
          },          : {Default match optionPUTPOSTDELETEGET
            : {Enter server profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "default-mode": "enumeration" Specify mode
Options:
 server 
            }
          }
        },        : {DHCP Server profilePUTPOSTDELETEGET
          : {NetBIOS node typePUTPOSTDELETEGET
            "hybrid-node": "string", Set string
            "mixed-node": "string", Set string
            "hexadecimal": "string", Hexadecimal number
            "broadcast-node": "string", Set string
            "peer-to-peer-node": "string" Set string
          },
          "subnet-mask": "string", Configure Subnet Mask
          "domain-name": "string", Domain name
          "boot-filename": "string", Boot Filename
          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option-number": "integer", Option number 
                "option-all": "integer" Set constant integer 
              }
            }
          },
          "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
          "next-server": "string", Configure the tftp-server IP to be used\nby the client
          : [Validate server ID checkPUTPOSTDELETEGET
            {
              "check": [ null ] specify requested-ip-address-check disable
            }
          ],
          "server-allow-move": [ null ], Allow dhcp subscriber move
          : {Specify limit leasePUTPOSTDELETEGET
            "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
            "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
          },
          "secure-arp": [ null ], Enable Secure Arp
          : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
            "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
          },          : {DNS serversPUTPOSTDELETEGET
            "dns-server": "string" DNS Server's IP address
          },
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : [NonePUTPOSTDELETEGET
            {
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
            }
          ],          : {NetBIOS name serversPUTPOSTDELETEGET
            "net-bios-name-server": "string" NetBIOSNameServer's IP address
          },
          "pool": "string", Specify the pool
          : [Change sessions configurationPUTPOSTDELETEGET
            {              : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                  "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                  "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                  "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                }
              }
            }
          ],          : {default routersPUTPOSTDELETEGET
            "default-router": "string" Router's IP address
          },          : [Insert match keywordPUTPOSTDELETEGET
            {              : {Table of OptionDefaultPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            }
          ],          : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
            : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
              "force-insert": [ null ] Set constant integer
            }
          },          : {Validate Requested IP AddressPUTPOSTDELETEGET
            "check": [ null ] specify requested-ip-address-check disable
          },          : {Table of ClassPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {                : {NetBIOS name serversPUTPOSTDELETEGET
                  "net-bios-name-server": "string" NetBIOSNameServer's IP address
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {
                    "l2-interface": "string", Specify match l2-interface
                    : {Table of Class-OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          "bit-mask": "string" Enter bit mask pattern string
                        }
                      ]
                    },
                    "vrf": "string" Specify match VRF
                  }
                ],                : {default routersPUTPOSTDELETEGET
                  "default-router": "string" Router's IP address
                },                : [Table of OptionCodePUTPOSTDELETEGET
                  {                    : [DHCP option codePUTPOSTDELETEGET
                      {
                        "option-code": "integer", DHCP option code
range: "0..255" 
                        "hex-string": "string", Hexadecimal string
                        "ascii-string": "string", ASCII string
                        "ip-address": "string", Server's IP address
                        "force-insert": "integer" Set constant integer 
                      }
                    ]
                  }
                ],
                "subnet-mask": "string", Configure Subnet Mask
                "boot-filename": "string", Boot Filename
                "class-name": "string", class name
                "domain-name": "string", Domain name
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                "next-server": "string", Configure the tftp-server IP to be used\nby the client
                : [NetBIOS node typePUTPOSTDELETEGET
                  {
                    "hybrid-node": "string", Set string
                    "mixed-node": "string", Set string
                    "hexadecimal": "string", Hexadecimal number
                    "broadcast-node": "string", Set string
                    "peer-to-peer-node": "string" Set string
                  }
                ],                : {DNS serversPUTPOSTDELETEGET
                  "dns-server": "string" DNS Server's IP address
                },
                "pool": "string", Specify the pool
                : [leasePUTPOSTDELETEGET
                  {
                    "infinite": "string", Set string
                    "hours": "integer", Hours
range: "0..23"
units: "hour" 
                    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                    "days": "integer" Days
range: "0..365"
units: "day" 
                  }
                ]
              }
            ]
          },          : {Table of OptionCodePUTPOSTDELETEGET
            : [DHCP option codePUTPOSTDELETEGET
              {
                "option-code": "integer", DHCP option code
range: "0..255" 
                "hex-string": "string", Hexadecimal string
                "ascii-string": "string", ASCII string
                "ip-address": "string", Server's IP address
                "force-insert": "integer" Set constant integer 
              }
            ]
          },          : [leasePUTPOSTDELETEGET
            {
              "infinite": "string", Set string
              "hours": "integer", Hours
range: "0..23"
units: "hour" 
              "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
              "days": "integer" Days
range: "0..365"
units: "day" 
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Delete operation of resource: modes

profile-name: string

in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Retrieve operation of resource: modes

profile-name: string

in path

ID of profile-name

200 OK

modes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPV4 Profile modesPUTPOSTDELETEGET
    : [Specify modePUTPOSTDELETEGET
      {        : {DHCP Relay profilePUTPOSTDELETEGET
          : {GIADDR policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
          },          : {Broadcast Flag policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
          },          : {VRF Helper AddressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper AddressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "gateway-address": "string", Gateway address
                      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                      "ip-address": "string" Server's IP address
                    }
                  ]
                }
              }
            ]
          },
          "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
          : {Relay agent information optionPUTPOSTDELETEGET
            "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
            "subscriber-id": "string", Subscriber ID
            "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
            : {Enter remote-id valuePUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "remote-id-value": "string" Enter remote-id value
            },
            "allow-untrusted": [ null ], Forward untrusted packets
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "vpn": [ null ], Insert VPN options
            "check": [ null ] specify requested-ip-address-check disable
          }
        },
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {DHCP proxy profilePUTPOSTDELETEGET
          : {Proxy limit leasePUTPOSTDELETEGET
            "limit-lease-count": "string", Limit lease count
range: "1..240000" 
            "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
          },          : {Specify broadcast flagPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
          },
          "secure-arp": [ null ], Enable Secure Arp
          : {Change sessions configurationPUTPOSTDELETEGET
            : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
              : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
              }
            }
          },          : {Authentication Username formatingPUTPOSTDELETEGET
            "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
            "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
          },          : {Specify gateway address policyPUTPOSTDELETEGET
            "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
          },          : {Insert match keywordPUTPOSTDELETEGET
            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                  "def-matchoption": "integer" Match option 60 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                  "matchoption": "integer", Match options 
                  "format": "integer" Set constant integer 
                }
              ]
            }
          },          : {DHCPv4 lease proxyPUTPOSTDELETEGET
            "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
            "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
          },          : {List of VRFsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper addressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "server-address": "string", IPv4 address
                      "gateway-address": "string" Gateway address
                    }
                  ]
                }
              }
            ]
          },
          "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {DHCP class tablePUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {                : {Match optionPUTPOSTDELETEGET
                  : {Match optionPUTPOSTDELETEGET
                    "pattern": "string", Enter hex pattern string
                    "bit-mask": "string", Enter bit mask pattern string
                    "option-type": "enumeration" Match option
Options: 
                  },
                  "vrf": "string" Specify match VRF
                },
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                "class-name": "string", class name
                : {List of VRFsPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "vrf-name": "string", VRF name
                      : {Helper addressesPUTPOSTDELETEGET
                        : [No descriptionPUTPOSTDELETEGET
                          {
                            "server-address": "string", IPv4 address
                            "gateway-address": "string" Gateway address
                          }
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          },
          "proxy-allow-move": [ null ], Allow dhcp subscriber move
          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option": "integer", No description
range: "1..255" 
                "option-all": "integer" Set constant integer 
              }
            }
          },          : [Relay agent information optionPUTPOSTDELETEGET
            {
              "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
              "option": [ null ], No description
              "remote-id-xr": [ null ], Insert Remote-id sub-option
              "allow-untrusted": [ null ], Forward untrusted packets
              "remote-id-suppress": [ null ], Suppress Remote ID
              "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
              "remote-id": "string", Enter remote-id value
              "circuit-id": [ null ], Insert Circuit-id sub-option
              "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
              "vpn": [ null ], Insert VPN options
              "check": [ null ] specify requested-ip-address-check disable
            }
          ]
        },        : {DHCP Snoop profilePUTPOSTDELETEGET
          : {DHCP Snoop profilePUTPOSTDELETEGET
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
            : {Enter remote-id valuePUTPOSTDELETEGET
              "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
              "remote-id-value": "string" Enter remote-id value
            },
            "allow-untrusted": [ null ] Forward untrusted packets
          },
          "trusted": [ null ] Trusted sources
        },
        "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
        : {DHCP Base ProfilePUTPOSTDELETEGET
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : {Enable the default profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "profile-mode": "integer" none 
          },          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option": "integer", No description
range: "1..255" 
                "option-all": "integer" Set constant integer 
              }
            }
          },          : [Insert match keywordPUTPOSTDELETEGET
            {              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchoption": "integer", Match options 
                    "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                    "format": "integer" Set constant integer 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "def-matchoption": "integer" Match option 60 
                  }
                ]
              }
            }
          ],          : {Insert match keywordPUTPOSTDELETEGET
            : {Table of ModeClassPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "class-name": "string", class name
                  : {Enter proxy or server profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile name
                    "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                  }
                }
              ]
            },            : {Specify match optionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "opt60": "integer", none
                  : {Enter a profilePUTPOSTDELETEGET
                    "profile-name": "string", Profile name
                    "profile-mode": "integer" none 
                  },
                  "opt60-hex-str": "string", Enter hex pattern string
                  "format": "integer" Set constant integer 
                }
              ]
            }
          },          : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
            "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
            "remote-id": "string" Enter remote-id value
          },          : {Default match optionPUTPOSTDELETEGET
            : {Enter server profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "default-mode": "enumeration" Specify mode
Options:
 server 
            }
          }
        },        : {DHCP Server profilePUTPOSTDELETEGET
          : {NetBIOS node typePUTPOSTDELETEGET
            "hybrid-node": "string", Set string
            "mixed-node": "string", Set string
            "hexadecimal": "string", Hexadecimal number
            "broadcast-node": "string", Set string
            "peer-to-peer-node": "string" Set string
          },
          "subnet-mask": "string", Configure Subnet Mask
          "domain-name": "string", Domain name
          "boot-filename": "string", Boot Filename
          : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
            : {option typePUTPOSTDELETEGET
              : {List of optionsPUTPOSTDELETEGET
                "option-number": "integer", Option number 
                "option-all": "integer" Set constant integer 
              }
            }
          },
          "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
          "next-server": "string", Configure the tftp-server IP to be used\nby the client
          : [Validate server ID checkPUTPOSTDELETEGET
            {
              "check": [ null ] specify requested-ip-address-check disable
            }
          ],
          "server-allow-move": [ null ], Allow dhcp subscriber move
          : {Specify limit leasePUTPOSTDELETEGET
            "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
            "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
          },
          "secure-arp": [ null ], Enable Secure Arp
          : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
            "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
          },          : {DNS serversPUTPOSTDELETEGET
            "dns-server": "string" DNS Server's IP address
          },
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          : [NonePUTPOSTDELETEGET
            {
              "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
            }
          ],          : {NetBIOS name serversPUTPOSTDELETEGET
            "net-bios-name-server": "string" NetBIOSNameServer's IP address
          },
          "pool": "string", Specify the pool
          : [Change sessions configurationPUTPOSTDELETEGET
            {              : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
                : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                  "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                  "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                  "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
                }
              }
            }
          ],          : {default routersPUTPOSTDELETEGET
            "default-router": "string" Router's IP address
          },          : [Insert match keywordPUTPOSTDELETEGET
            {              : {Table of OptionDefaultPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  }
                ]
              },              : {Table of OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                    "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    "format": "integer" Set constant integer 
                  }
                ]
              }
            }
          ],          : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
            : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
              "force-insert": [ null ] Set constant integer
            }
          },          : {Validate Requested IP AddressPUTPOSTDELETEGET
            "check": [ null ] specify requested-ip-address-check disable
          },          : {Table of ClassPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {                : {NetBIOS name serversPUTPOSTDELETEGET
                  "net-bios-name-server": "string" NetBIOSNameServer's IP address
                },                : [Insert match keywordPUTPOSTDELETEGET
                  {
                    "l2-interface": "string", Specify match l2-interface
                    : {Table of Class-OptionPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "pattern": "string", Enter hex pattern string
                          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                          "bit-mask": "string" Enter bit mask pattern string
                        }
                      ]
                    },
                    "vrf": "string" Specify match VRF
                  }
                ],                : {default routersPUTPOSTDELETEGET
                  "default-router": "string" Router's IP address
                },                : [Table of OptionCodePUTPOSTDELETEGET
                  {                    : [DHCP option codePUTPOSTDELETEGET
                      {
                        "option-code": "integer", DHCP option code
range: "0..255" 
                        "hex-string": "string", Hexadecimal string
                        "ascii-string": "string", ASCII string
                        "ip-address": "string", Server's IP address
                        "force-insert": "integer" Set constant integer 
                      }
                    ]
                  }
                ],
                "subnet-mask": "string", Configure Subnet Mask
                "boot-filename": "string", Boot Filename
                "class-name": "string", class name
                "domain-name": "string", Domain name
                "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                "next-server": "string", Configure the tftp-server IP to be used\nby the client
                : [NetBIOS node typePUTPOSTDELETEGET
                  {
                    "hybrid-node": "string", Set string
                    "mixed-node": "string", Set string
                    "hexadecimal": "string", Hexadecimal number
                    "broadcast-node": "string", Set string
                    "peer-to-peer-node": "string" Set string
                  }
                ],                : {DNS serversPUTPOSTDELETEGET
                  "dns-server": "string" DNS Server's IP address
                },
                "pool": "string", Specify the pool
                : [leasePUTPOSTDELETEGET
                  {
                    "infinite": "string", Set string
                    "hours": "integer", Hours
range: "0..23"
units: "hour" 
                    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                    "days": "integer" Days
range: "0..365"
units: "day" 
                  }
                ]
              }
            ]
          },          : {Table of OptionCodePUTPOSTDELETEGET
            : [DHCP option codePUTPOSTDELETEGET
              {
                "option-code": "integer", DHCP option code
range: "0..255" 
                "hex-string": "string", Hexadecimal string
                "ascii-string": "string", ASCII string
                "ip-address": "string", Server's IP address
                "force-insert": "integer" Set constant integer 
              }
            ]
          },          : [leasePUTPOSTDELETEGET
            {
              "infinite": "string", Set string
              "hours": "integer", Hours
range: "0..23"
units: "hour" 
              "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
              "days": "integer" Days
range: "0..365"
units: "day" 
            }
          ]
        }
      }
    ]
  }
}

MODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Update operation of resource: mode

mode_schema

modebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : [Specify modePUTPOSTDELETEGET
    {      : {DHCP Relay profilePUTPOSTDELETEGET
        : {GIADDR policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
        },        : {Broadcast Flag policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
        },        : {VRF Helper AddressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper AddressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "gateway-address": "string", Gateway address
                    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                    "ip-address": "string" Server's IP address
                  }
                ]
              }
            }
          ]
        },
        "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
        : {Relay agent information optionPUTPOSTDELETEGET
          "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
          "subscriber-id": "string", Subscriber ID
          "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
          : {Enter remote-id valuePUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "remote-id-value": "string" Enter remote-id value
          },
          "allow-untrusted": [ null ], Forward untrusted packets
          "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
          "vpn": [ null ], Insert VPN options
          "check": [ null ] specify requested-ip-address-check disable
        }
      },
      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
      : {DHCP proxy profilePUTPOSTDELETEGET
        : {Proxy limit leasePUTPOSTDELETEGET
          "limit-lease-count": "string", Limit lease count
range: "1..240000" 
          "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
        },        : {Specify broadcast flagPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
        },
        "secure-arp": [ null ], Enable Secure Arp
        : {Change sessions configurationPUTPOSTDELETEGET
          : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
            : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
              "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
              "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
              "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
            }
          }
        },        : {Authentication Username formatingPUTPOSTDELETEGET
          "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
          "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
        },        : {Specify gateway address policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
        },        : {Insert match keywordPUTPOSTDELETEGET
          : {Table of OptionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                "def-matchoption": "integer" Match option 60 
              }
            ]
          },          : {Table of OptionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "pattern": "string", Enter hex pattern string
                "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                "matchoption": "integer", Match options 
                "format": "integer" Set constant integer 
              }
            ]
          }
        },        : {DHCPv4 lease proxyPUTPOSTDELETEGET
          "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
          "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
        },        : {List of VRFsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper addressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "server-address": "string", IPv4 address
                    "gateway-address": "string" Gateway address
                  }
                ]
              }
            }
          ]
        },
        "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {DHCP class tablePUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {              : {Match optionPUTPOSTDELETEGET
                : {Match optionPUTPOSTDELETEGET
                  "pattern": "string", Enter hex pattern string
                  "bit-mask": "string", Enter bit mask pattern string
                  "option-type": "enumeration" Match option
Options: 
                },
                "vrf": "string" Specify match VRF
              },
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              "class-name": "string", class name
              : {List of VRFsPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "vrf-name": "string", VRF name
                    : {Helper addressesPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "server-address": "string", IPv4 address
                          "gateway-address": "string" Gateway address
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        },
        "proxy-allow-move": [ null ], Allow dhcp subscriber move
        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option": "integer", No description
range: "1..255" 
              "option-all": "integer" Set constant integer 
            }
          }
        },        : [Relay agent information optionPUTPOSTDELETEGET
          {
            "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
            "option": [ null ], No description
            "remote-id-xr": [ null ], Insert Remote-id sub-option
            "allow-untrusted": [ null ], Forward untrusted packets
            "remote-id-suppress": [ null ], Suppress Remote ID
            "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
            "remote-id": "string", Enter remote-id value
            "circuit-id": [ null ], Insert Circuit-id sub-option
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "vpn": [ null ], Insert VPN options
            "check": [ null ] specify requested-ip-address-check disable
          }
        ]
      },      : {DHCP Snoop profilePUTPOSTDELETEGET
        : {DHCP Snoop profilePUTPOSTDELETEGET
          "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
          "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
          : {Enter remote-id valuePUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "remote-id-value": "string" Enter remote-id value
          },
          "allow-untrusted": [ null ] Forward untrusted packets
        },
        "trusted": [ null ] Trusted sources
      },
      "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
      : {DHCP Base ProfilePUTPOSTDELETEGET
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {Enable the default profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "profile-mode": "integer" none 
        },        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option": "integer", No description
range: "1..255" 
              "option-all": "integer" Set constant integer 
            }
          }
        },        : [Insert match keywordPUTPOSTDELETEGET
          {            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchoption": "integer", Match options 
                  "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                  "format": "integer" Set constant integer 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "def-matchoption": "integer" Match option 60 
                }
              ]
            }
          }
        ],        : {Insert match keywordPUTPOSTDELETEGET
          : {Table of ModeClassPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "class-name": "string", class name
                : {Enter proxy or server profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile name
                  "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                }
              }
            ]
          },          : {Specify match optionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "opt60": "integer", none
                : {Enter a profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile name
                  "profile-mode": "integer" none 
                },
                "opt60-hex-str": "string", Enter hex pattern string
                "format": "integer" Set constant integer 
              }
            ]
          }
        },        : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
          "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
          "remote-id": "string" Enter remote-id value
        },        : {Default match optionPUTPOSTDELETEGET
          : {Enter server profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "default-mode": "enumeration" Specify mode
Options:
 server 
          }
        }
      },      : {DHCP Server profilePUTPOSTDELETEGET
        : {NetBIOS node typePUTPOSTDELETEGET
          "hybrid-node": "string", Set string
          "mixed-node": "string", Set string
          "hexadecimal": "string", Hexadecimal number
          "broadcast-node": "string", Set string
          "peer-to-peer-node": "string" Set string
        },
        "subnet-mask": "string", Configure Subnet Mask
        "domain-name": "string", Domain name
        "boot-filename": "string", Boot Filename
        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option-number": "integer", Option number 
              "option-all": "integer" Set constant integer 
            }
          }
        },
        "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
        "next-server": "string", Configure the tftp-server IP to be used\nby the client
        : [Validate server ID checkPUTPOSTDELETEGET
          {
            "check": [ null ] specify requested-ip-address-check disable
          }
        ],
        "server-allow-move": [ null ], Allow dhcp subscriber move
        : {Specify limit leasePUTPOSTDELETEGET
          "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
          "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
        },
        "secure-arp": [ null ], Enable Secure Arp
        : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
          "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
        },        : {DNS serversPUTPOSTDELETEGET
          "dns-server": "string" DNS Server's IP address
        },
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : [NonePUTPOSTDELETEGET
          {
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
          }
        ],        : {NetBIOS name serversPUTPOSTDELETEGET
          "net-bios-name-server": "string" NetBIOSNameServer's IP address
        },
        "pool": "string", Specify the pool
        : [Change sessions configurationPUTPOSTDELETEGET
          {            : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
              : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
              }
            }
          }
        ],        : {default routersPUTPOSTDELETEGET
          "default-router": "string" Router's IP address
        },        : [Insert match keywordPUTPOSTDELETEGET
          {            : {Table of OptionDefaultPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  "format": "integer" Set constant integer 
                }
              ]
            }
          }
        ],        : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
          : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
            "force-insert": [ null ] Set constant integer
          }
        },        : {Validate Requested IP AddressPUTPOSTDELETEGET
          "check": [ null ] specify requested-ip-address-check disable
        },        : {Table of ClassPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {              : {NetBIOS name serversPUTPOSTDELETEGET
                "net-bios-name-server": "string" NetBIOSNameServer's IP address
              },              : [Insert match keywordPUTPOSTDELETEGET
                {
                  "l2-interface": "string", Specify match l2-interface
                  : {Table of Class-OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "pattern": "string", Enter hex pattern string
                        "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                        "bit-mask": "string" Enter bit mask pattern string
                      }
                    ]
                  },
                  "vrf": "string" Specify match VRF
                }
              ],              : {default routersPUTPOSTDELETEGET
                "default-router": "string" Router's IP address
              },              : [Table of OptionCodePUTPOSTDELETEGET
                {                  : [DHCP option codePUTPOSTDELETEGET
                    {
                      "option-code": "integer", DHCP option code
range: "0..255" 
                      "hex-string": "string", Hexadecimal string
                      "ascii-string": "string", ASCII string
                      "ip-address": "string", Server's IP address
                      "force-insert": "integer" Set constant integer 
                    }
                  ]
                }
              ],
              "subnet-mask": "string", Configure Subnet Mask
              "boot-filename": "string", Boot Filename
              "class-name": "string", class name
              "domain-name": "string", Domain name
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              "next-server": "string", Configure the tftp-server IP to be used\nby the client
              : [NetBIOS node typePUTPOSTDELETEGET
                {
                  "hybrid-node": "string", Set string
                  "mixed-node": "string", Set string
                  "hexadecimal": "string", Hexadecimal number
                  "broadcast-node": "string", Set string
                  "peer-to-peer-node": "string" Set string
                }
              ],              : {DNS serversPUTPOSTDELETEGET
                "dns-server": "string" DNS Server's IP address
              },
              "pool": "string", Specify the pool
              : [leasePUTPOSTDELETEGET
                {
                  "infinite": "string", Set string
                  "hours": "integer", Hours
range: "0..23"
units: "hour" 
                  "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                  "days": "integer" Days
range: "0..365"
units: "day" 
                }
              ]
            }
          ]
        },        : {Table of OptionCodePUTPOSTDELETEGET
          : [DHCP option codePUTPOSTDELETEGET
            {
              "option-code": "integer", DHCP option code
range: "0..255" 
              "hex-string": "string", Hexadecimal string
              "ascii-string": "string", ASCII string
              "ip-address": "string", Server's IP address
              "force-insert": "integer" Set constant integer 
            }
          ]
        },        : [leasePUTPOSTDELETEGET
          {
            "infinite": "string", Set string
            "hours": "integer", Hours
range: "0..23"
units: "hour" 
            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
            "days": "integer" Days
range: "0..365"
units: "day" 
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Create operation of resource: mode

mode_schema

modebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : [Specify modePUTPOSTDELETEGET
    {      : {DHCP Relay profilePUTPOSTDELETEGET
        : {GIADDR policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
        },        : {Broadcast Flag policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
        },        : {VRF Helper AddressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper AddressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "gateway-address": "string", Gateway address
                    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                    "ip-address": "string" Server's IP address
                  }
                ]
              }
            }
          ]
        },
        "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
        : {Relay agent information optionPUTPOSTDELETEGET
          "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
          "subscriber-id": "string", Subscriber ID
          "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
          : {Enter remote-id valuePUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "remote-id-value": "string" Enter remote-id value
          },
          "allow-untrusted": [ null ], Forward untrusted packets
          "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
          "vpn": [ null ], Insert VPN options
          "check": [ null ] specify requested-ip-address-check disable
        }
      },
      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
      : {DHCP proxy profilePUTPOSTDELETEGET
        : {Proxy limit leasePUTPOSTDELETEGET
          "limit-lease-count": "string", Limit lease count
range: "1..240000" 
          "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
        },        : {Specify broadcast flagPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
        },
        "secure-arp": [ null ], Enable Secure Arp
        : {Change sessions configurationPUTPOSTDELETEGET
          : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
            : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
              "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
              "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
              "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
            }
          }
        },        : {Authentication Username formatingPUTPOSTDELETEGET
          "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
          "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
        },        : {Specify gateway address policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
        },        : {Insert match keywordPUTPOSTDELETEGET
          : {Table of OptionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                "def-matchoption": "integer" Match option 60 
              }
            ]
          },          : {Table of OptionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "pattern": "string", Enter hex pattern string
                "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                "matchoption": "integer", Match options 
                "format": "integer" Set constant integer 
              }
            ]
          }
        },        : {DHCPv4 lease proxyPUTPOSTDELETEGET
          "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
          "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
        },        : {List of VRFsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper addressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "server-address": "string", IPv4 address
                    "gateway-address": "string" Gateway address
                  }
                ]
              }
            }
          ]
        },
        "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {DHCP class tablePUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {              : {Match optionPUTPOSTDELETEGET
                : {Match optionPUTPOSTDELETEGET
                  "pattern": "string", Enter hex pattern string
                  "bit-mask": "string", Enter bit mask pattern string
                  "option-type": "enumeration" Match option
Options: 
                },
                "vrf": "string" Specify match VRF
              },
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              "class-name": "string", class name
              : {List of VRFsPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "vrf-name": "string", VRF name
                    : {Helper addressesPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "server-address": "string", IPv4 address
                          "gateway-address": "string" Gateway address
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        },
        "proxy-allow-move": [ null ], Allow dhcp subscriber move
        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option": "integer", No description
range: "1..255" 
              "option-all": "integer" Set constant integer 
            }
          }
        },        : [Relay agent information optionPUTPOSTDELETEGET
          {
            "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
            "option": [ null ], No description
            "remote-id-xr": [ null ], Insert Remote-id sub-option
            "allow-untrusted": [ null ], Forward untrusted packets
            "remote-id-suppress": [ null ], Suppress Remote ID
            "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
            "remote-id": "string", Enter remote-id value
            "circuit-id": [ null ], Insert Circuit-id sub-option
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "vpn": [ null ], Insert VPN options
            "check": [ null ] specify requested-ip-address-check disable
          }
        ]
      },      : {DHCP Snoop profilePUTPOSTDELETEGET
        : {DHCP Snoop profilePUTPOSTDELETEGET
          "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
          "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
          : {Enter remote-id valuePUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "remote-id-value": "string" Enter remote-id value
          },
          "allow-untrusted": [ null ] Forward untrusted packets
        },
        "trusted": [ null ] Trusted sources
      },
      "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
      : {DHCP Base ProfilePUTPOSTDELETEGET
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {Enable the default profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "profile-mode": "integer" none 
        },        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option": "integer", No description
range: "1..255" 
              "option-all": "integer" Set constant integer 
            }
          }
        },        : [Insert match keywordPUTPOSTDELETEGET
          {            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchoption": "integer", Match options 
                  "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                  "format": "integer" Set constant integer 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "def-matchoption": "integer" Match option 60 
                }
              ]
            }
          }
        ],        : {Insert match keywordPUTPOSTDELETEGET
          : {Table of ModeClassPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "class-name": "string", class name
                : {Enter proxy or server profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile name
                  "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                }
              }
            ]
          },          : {Specify match optionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "opt60": "integer", none
                : {Enter a profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile name
                  "profile-mode": "integer" none 
                },
                "opt60-hex-str": "string", Enter hex pattern string
                "format": "integer" Set constant integer 
              }
            ]
          }
        },        : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
          "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
          "remote-id": "string" Enter remote-id value
        },        : {Default match optionPUTPOSTDELETEGET
          : {Enter server profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "default-mode": "enumeration" Specify mode
Options:
 server 
          }
        }
      },      : {DHCP Server profilePUTPOSTDELETEGET
        : {NetBIOS node typePUTPOSTDELETEGET
          "hybrid-node": "string", Set string
          "mixed-node": "string", Set string
          "hexadecimal": "string", Hexadecimal number
          "broadcast-node": "string", Set string
          "peer-to-peer-node": "string" Set string
        },
        "subnet-mask": "string", Configure Subnet Mask
        "domain-name": "string", Domain name
        "boot-filename": "string", Boot Filename
        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option-number": "integer", Option number 
              "option-all": "integer" Set constant integer 
            }
          }
        },
        "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
        "next-server": "string", Configure the tftp-server IP to be used\nby the client
        : [Validate server ID checkPUTPOSTDELETEGET
          {
            "check": [ null ] specify requested-ip-address-check disable
          }
        ],
        "server-allow-move": [ null ], Allow dhcp subscriber move
        : {Specify limit leasePUTPOSTDELETEGET
          "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
          "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
        },
        "secure-arp": [ null ], Enable Secure Arp
        : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
          "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
        },        : {DNS serversPUTPOSTDELETEGET
          "dns-server": "string" DNS Server's IP address
        },
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : [NonePUTPOSTDELETEGET
          {
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
          }
        ],        : {NetBIOS name serversPUTPOSTDELETEGET
          "net-bios-name-server": "string" NetBIOSNameServer's IP address
        },
        "pool": "string", Specify the pool
        : [Change sessions configurationPUTPOSTDELETEGET
          {            : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
              : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
              }
            }
          }
        ],        : {default routersPUTPOSTDELETEGET
          "default-router": "string" Router's IP address
        },        : [Insert match keywordPUTPOSTDELETEGET
          {            : {Table of OptionDefaultPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  "format": "integer" Set constant integer 
                }
              ]
            }
          }
        ],        : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
          : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
            "force-insert": [ null ] Set constant integer
          }
        },        : {Validate Requested IP AddressPUTPOSTDELETEGET
          "check": [ null ] specify requested-ip-address-check disable
        },        : {Table of ClassPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {              : {NetBIOS name serversPUTPOSTDELETEGET
                "net-bios-name-server": "string" NetBIOSNameServer's IP address
              },              : [Insert match keywordPUTPOSTDELETEGET
                {
                  "l2-interface": "string", Specify match l2-interface
                  : {Table of Class-OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "pattern": "string", Enter hex pattern string
                        "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                        "bit-mask": "string" Enter bit mask pattern string
                      }
                    ]
                  },
                  "vrf": "string" Specify match VRF
                }
              ],              : {default routersPUTPOSTDELETEGET
                "default-router": "string" Router's IP address
              },              : [Table of OptionCodePUTPOSTDELETEGET
                {                  : [DHCP option codePUTPOSTDELETEGET
                    {
                      "option-code": "integer", DHCP option code
range: "0..255" 
                      "hex-string": "string", Hexadecimal string
                      "ascii-string": "string", ASCII string
                      "ip-address": "string", Server's IP address
                      "force-insert": "integer" Set constant integer 
                    }
                  ]
                }
              ],
              "subnet-mask": "string", Configure Subnet Mask
              "boot-filename": "string", Boot Filename
              "class-name": "string", class name
              "domain-name": "string", Domain name
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              "next-server": "string", Configure the tftp-server IP to be used\nby the client
              : [NetBIOS node typePUTPOSTDELETEGET
                {
                  "hybrid-node": "string", Set string
                  "mixed-node": "string", Set string
                  "hexadecimal": "string", Hexadecimal number
                  "broadcast-node": "string", Set string
                  "peer-to-peer-node": "string" Set string
                }
              ],              : {DNS serversPUTPOSTDELETEGET
                "dns-server": "string" DNS Server's IP address
              },
              "pool": "string", Specify the pool
              : [leasePUTPOSTDELETEGET
                {
                  "infinite": "string", Set string
                  "hours": "integer", Hours
range: "0..23"
units: "hour" 
                  "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                  "days": "integer" Days
range: "0..365"
units: "day" 
                }
              ]
            }
          ]
        },        : {Table of OptionCodePUTPOSTDELETEGET
          : [DHCP option codePUTPOSTDELETEGET
            {
              "option-code": "integer", DHCP option code
range: "0..255" 
              "hex-string": "string", Hexadecimal string
              "ascii-string": "string", ASCII string
              "ip-address": "string", Server's IP address
              "force-insert": "integer" Set constant integer 
            }
          ]
        },        : [leasePUTPOSTDELETEGET
          {
            "infinite": "string", Set string
            "hours": "integer", Hours
range: "0..23"
units: "hour" 
            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
            "days": "integer" Days
range: "0..365"
units: "day" 
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Delete operation of resource: mode

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Retrieve operation of resource: mode

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

mode_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [Specify modePUTPOSTDELETEGET
    {      : {DHCP Relay profilePUTPOSTDELETEGET
        : {GIADDR policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 replace
 drop 
        },        : {Broadcast Flag policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
        },        : {VRF Helper AddressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper AddressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "gateway-address": "string", Gateway address
                    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
                    "ip-address": "string" Server's IP address
                  }
                ]
              }
            }
          ]
        },
        "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
        : {Relay agent information optionPUTPOSTDELETEGET
          "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
          "subscriber-id": "string", Subscriber ID
          "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
          : {Enter remote-id valuePUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "remote-id-value": "string" Enter remote-id value
          },
          "allow-untrusted": [ null ], Forward untrusted packets
          "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
          "vpn": [ null ], Insert VPN options
          "check": [ null ] specify requested-ip-address-check disable
        }
      },
      "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
      : {DHCP proxy profilePUTPOSTDELETEGET
        : {Proxy limit leasePUTPOSTDELETEGET
          "limit-lease-count": "string", Limit lease count
range: "1..240000" 
          "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
        },        : {Specify broadcast flagPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicast-always 
        },
        "secure-arp": [ null ], Enable Secure Arp
        : {Change sessions configurationPUTPOSTDELETEGET
          : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
            : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
              "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
              "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
              "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
            }
          }
        },        : {Authentication Username formatingPUTPOSTDELETEGET
          "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
          "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
        },        : {Specify gateway address policyPUTPOSTDELETEGET
          "policy": "enumeration" Specify broadcast flag policy
Options:
 giaddr-policy-keep 
        },        : {Insert match keywordPUTPOSTDELETEGET
          : {Table of OptionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                "def-matchoption": "integer" Match option 60 
              }
            ]
          },          : {Table of OptionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "pattern": "string", Enter hex pattern string
                "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
                "matchoption": "integer", Match options 
                "format": "integer" Set constant integer 
              }
            ]
          }
        },        : {DHCPv4 lease proxyPUTPOSTDELETEGET
          "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
          "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
        },        : {List of VRFsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper addressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "server-address": "string", IPv4 address
                    "gateway-address": "string" Gateway address
                  }
                ]
              }
            }
          ]
        },
        "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {DHCP class tablePUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {              : {Match optionPUTPOSTDELETEGET
                : {Match optionPUTPOSTDELETEGET
                  "pattern": "string", Enter hex pattern string
                  "bit-mask": "string", Enter bit mask pattern string
                  "option-type": "enumeration" Match option
Options: 
                },
                "vrf": "string" Specify match VRF
              },
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              "class-name": "string", class name
              : {List of VRFsPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "vrf-name": "string", VRF name
                    : {Helper addressesPUTPOSTDELETEGET
                      : [No descriptionPUTPOSTDELETEGET
                        {
                          "server-address": "string", IPv4 address
                          "gateway-address": "string" Gateway address
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        },
        "proxy-allow-move": [ null ], Allow dhcp subscriber move
        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option": "integer", No description
range: "1..255" 
              "option-all": "integer" Set constant integer 
            }
          }
        },        : [Relay agent information optionPUTPOSTDELETEGET
          {
            "authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
 received
 inserted 
            "option": [ null ], No description
            "remote-id-xr": [ null ], Insert Remote-id sub-option
            "allow-untrusted": [ null ], Forward untrusted packets
            "remote-id-suppress": [ null ], Suppress Remote ID
            "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
            "remote-id": "string", Enter remote-id value
            "circuit-id": [ null ], Insert Circuit-id sub-option
            "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
            "vpn": [ null ], Insert VPN options
            "check": [ null ] specify requested-ip-address-check disable
          }
        ]
      },      : {DHCP Snoop profilePUTPOSTDELETEGET
        : {DHCP Snoop profilePUTPOSTDELETEGET
          "policy": "enumeration", Specify broadcast flag policy
Options:
 replace
 keep
 drop
 encapsulate 
          "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
          : {Enter remote-id valuePUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "remote-id-value": "string" Enter remote-id value
          },
          "allow-untrusted": [ null ] Forward untrusted packets
        },
        "trusted": [ null ] Trusted sources
      },
      "mode": "enumeration", Specify mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2
      : {DHCP Base ProfilePUTPOSTDELETEGET
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : {Enable the default profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "profile-mode": "integer" none 
        },        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option": "integer", No description
range: "1..255" 
              "option-all": "integer" Set constant integer 
            }
          }
        },        : [Insert match keywordPUTPOSTDELETEGET
          {            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchoption": "integer", Match options 
                  "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
                  "format": "integer" Set constant integer 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "def-matchoption": "integer" Match option 60 
                }
              ]
            }
          }
        ],        : {Insert match keywordPUTPOSTDELETEGET
          : {Table of ModeClassPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "class-name": "string", class name
                : {Enter proxy or server profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile name
                  "mode": "enumeration" Specify mode
Options:
 server
 proxy 
                }
              }
            ]
          },          : {Specify match optionPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "opt60": "integer", none
                : {Enter a profilePUTPOSTDELETEGET
                  "profile-name": "string", Profile name
                  "profile-mode": "integer" none 
                },
                "opt60-hex-str": "string", Enter hex pattern string
                "format": "integer" Set constant integer 
              }
            ]
          }
        },        : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
          "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
          "remote-id": "string" Enter remote-id value
        },        : {Default match optionPUTPOSTDELETEGET
          : {Enter server profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "default-mode": "enumeration" Specify mode
Options:
 server 
          }
        }
      },      : {DHCP Server profilePUTPOSTDELETEGET
        : {NetBIOS node typePUTPOSTDELETEGET
          "hybrid-node": "string", Set string
          "mixed-node": "string", Set string
          "hexadecimal": "string", Hexadecimal number
          "broadcast-node": "string", Set string
          "peer-to-peer-node": "string" Set string
        },
        "subnet-mask": "string", Configure Subnet Mask
        "domain-name": "string", Domain name
        "boot-filename": "string", Boot Filename
        : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
          : {option typePUTPOSTDELETEGET
            : {List of optionsPUTPOSTDELETEGET
              "option-number": "integer", Option number 
              "option-all": "integer" Set constant integer 
            }
          }
        },
        "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
        "next-server": "string", Configure the tftp-server IP to be used\nby the client
        : [Validate server ID checkPUTPOSTDELETEGET
          {
            "check": [ null ] specify requested-ip-address-check disable
          }
        ],
        "server-allow-move": [ null ], Allow dhcp subscriber move
        : {Specify limit leasePUTPOSTDELETEGET
          "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
          "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
        },
        "secure-arp": [ null ], Enable Secure Arp
        : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
          "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
        },        : {DNS serversPUTPOSTDELETEGET
          "dns-server": "string" DNS Server's IP address
        },
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        : [NonePUTPOSTDELETEGET
          {
            "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
          }
        ],        : {NetBIOS name serversPUTPOSTDELETEGET
          "net-bios-name-server": "string" NetBIOSNameServer's IP address
        },
        "pool": "string", Specify the pool
        : [Change sessions configurationPUTPOSTDELETEGET
          {            : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
              : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
                "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
                "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
                "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
              }
            }
          }
        ],        : {default routersPUTPOSTDELETEGET
          "default-router": "string" Router's IP address
        },        : [Insert match keywordPUTPOSTDELETEGET
          {            : {Table of OptionDefaultPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                }
              ]
            },            : {Table of OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  "format": "integer" Set constant integer 
                }
              ]
            }
          }
        ],        : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
          : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
            "force-insert": [ null ] Set constant integer
          }
        },        : {Validate Requested IP AddressPUTPOSTDELETEGET
          "check": [ null ] specify requested-ip-address-check disable
        },        : {Table of ClassPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {              : {NetBIOS name serversPUTPOSTDELETEGET
                "net-bios-name-server": "string" NetBIOSNameServer's IP address
              },              : [Insert match keywordPUTPOSTDELETEGET
                {
                  "l2-interface": "string", Specify match l2-interface
                  : {Table of Class-OptionPUTPOSTDELETEGET
                    : [No descriptionPUTPOSTDELETEGET
                      {
                        "pattern": "string", Enter hex pattern string
                        "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                        "bit-mask": "string" Enter bit mask pattern string
                      }
                    ]
                  },
                  "vrf": "string" Specify match VRF
                }
              ],              : {default routersPUTPOSTDELETEGET
                "default-router": "string" Router's IP address
              },              : [Table of OptionCodePUTPOSTDELETEGET
                {                  : [DHCP option codePUTPOSTDELETEGET
                    {
                      "option-code": "integer", DHCP option code
range: "0..255" 
                      "hex-string": "string", Hexadecimal string
                      "ascii-string": "string", ASCII string
                      "ip-address": "string", Server's IP address
                      "force-insert": "integer" Set constant integer 
                    }
                  ]
                }
              ],
              "subnet-mask": "string", Configure Subnet Mask
              "boot-filename": "string", Boot Filename
              "class-name": "string", class name
              "domain-name": "string", Domain name
              "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
              "next-server": "string", Configure the tftp-server IP to be used\nby the client
              : [NetBIOS node typePUTPOSTDELETEGET
                {
                  "hybrid-node": "string", Set string
                  "mixed-node": "string", Set string
                  "hexadecimal": "string", Hexadecimal number
                  "broadcast-node": "string", Set string
                  "peer-to-peer-node": "string" Set string
                }
              ],              : {DNS serversPUTPOSTDELETEGET
                "dns-server": "string" DNS Server's IP address
              },
              "pool": "string", Specify the pool
              : [leasePUTPOSTDELETEGET
                {
                  "infinite": "string", Set string
                  "hours": "integer", Hours
range: "0..23"
units: "hour" 
                  "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
                  "days": "integer" Days
range: "0..365"
units: "day" 
                }
              ]
            }
          ]
        },        : {Table of OptionCodePUTPOSTDELETEGET
          : [DHCP option codePUTPOSTDELETEGET
            {
              "option-code": "integer", DHCP option code
range: "0..255" 
              "hex-string": "string", Hexadecimal string
              "ascii-string": "string", ASCII string
              "ip-address": "string", Server's IP address
              "force-insert": "integer" Set constant integer 
            }
          ]
        },        : [leasePUTPOSTDELETEGET
          {
            "infinite": "string", Set string
            "hours": "integer", Hours
range: "0..23"
units: "hour" 
            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
            "days": "integer" Days
range: "0..365"
units: "day" 
          }
        ]
      }
    }
  ]
}

SNOOP - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Update operation of resource: snoop

snoop_schema

snoopbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Snoop profilePUTPOSTDELETEGET
    : {DHCP Snoop profilePUTPOSTDELETEGET
      "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
      "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
      : {Enter remote-id valuePUTPOSTDELETEGET
        "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
        "remote-id-value": "string" Enter remote-id value
      },
      "allow-untrusted": [ null ] Forward untrusted packets
    },
    "trusted": [ null ] Trusted sources
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Create operation of resource: snoop

snoop_schema

snoopbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Snoop profilePUTPOSTDELETEGET
    : {DHCP Snoop profilePUTPOSTDELETEGET
      "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
      "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
      : {Enter remote-id valuePUTPOSTDELETEGET
        "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
        "remote-id-value": "string" Enter remote-id value
      },
      "allow-untrusted": [ null ] Forward untrusted packets
    },
    "trusted": [ null ] Trusted sources
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Delete operation of resource: snoop

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Retrieve operation of resource: snoop

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

snoop_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP Snoop profilePUTPOSTDELETEGET
    : {DHCP Snoop profilePUTPOSTDELETEGET
      "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
      "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
      : {Enter remote-id valuePUTPOSTDELETEGET
        "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
        "remote-id-value": "string" Enter remote-id value
      },
      "allow-untrusted": [ null ] Forward untrusted packets
    },
    "trusted": [ null ] Trusted sources
  }
}

RELAY-INFORMATION-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Update operation of resource: relay-information-option

relay-information-option_schema

relay-information-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Snoop profilePUTPOSTDELETEGET
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
    : {Enter remote-id valuePUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "remote-id-value": "string" Enter remote-id value
    },
    "allow-untrusted": [ null ] Forward untrusted packets
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Create operation of resource: relay-information-option

relay-information-option_schema

relay-information-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Snoop profilePUTPOSTDELETEGET
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
    : {Enter remote-id valuePUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "remote-id-value": "string" Enter remote-id value
    },
    "allow-untrusted": [ null ] Forward untrusted packets
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Delete operation of resource: relay-information-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Retrieve operation of resource: relay-information-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

relay-information-option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP Snoop profilePUTPOSTDELETEGET
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
    : {Enter remote-id valuePUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "remote-id-value": "string" Enter remote-id value
    },
    "allow-untrusted": [ null ] Forward untrusted packets
  }
}

REMOTE-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Update operation of resource: remote-id

remote-id_schema

remote-idbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enter remote-id valuePUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "remote-id-value": "string" Enter remote-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Create operation of resource: remote-id

remote-id_schema

remote-idbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enter remote-id valuePUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "remote-id-value": "string" Enter remote-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Delete operation of resource: remote-id

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Retrieve operation of resource: remote-id

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

remote-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enter remote-id valuePUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "remote-id-value": "string" Enter remote-id value
  }
}

BASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Update operation of resource: base

base_schema

basebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Base ProfilePUTPOSTDELETEGET
    "enable": [ null ], Enable the DHCP IPv4 Base Profile
    : {Enable the default profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "profile-mode": "integer" none 
    },    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option": "integer", No description
range: "1..255" 
          "option-all": "integer" option all 
        }
      }
    },    : [Insert match keywordPUTPOSTDELETEGET
      {        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchoption": "integer", Match option 60 
              "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
              "format": "integer" Set constant integer 
            }
          ]
        },        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "def-matchoption": "integer" Match option 60 
            }
          ]
        }
      }
    ],    : {Insert match keywordPUTPOSTDELETEGET
      : {Table of ModeClassPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "class-name": "string", Class name
            : {Enter proxy or server profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "mode": "enumeration" Specify mode
Options:
 server
 proxy 
            }
          }
        ]
      },      : {Specify match optionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "opt60": "integer", none
            : {Enter a profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "profile-mode": "integer" none 
            },
            "opt60-hex-str": "string", Enter hex pattern string
            "format": "integer" Set constant integer 
          }
        ]
      }
    },    : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
      "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
      "remote-id": "string" Enter remote-id value
    },    : {Default match optionPUTPOSTDELETEGET
      : {Enter server profilePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "default-mode": "enumeration" Specify mode
Options:
 server 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Create operation of resource: base

base_schema

basebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Base ProfilePUTPOSTDELETEGET
    "enable": [ null ], Enable the DHCP IPv4 Base Profile
    : {Enable the default profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "profile-mode": "integer" none 
    },    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option": "integer", No description
range: "1..255" 
          "option-all": "integer" option all 
        }
      }
    },    : [Insert match keywordPUTPOSTDELETEGET
      {        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchoption": "integer", Match option 60 
              "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
              "format": "integer" Set constant integer 
            }
          ]
        },        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "def-matchoption": "integer" Match option 60 
            }
          ]
        }
      }
    ],    : {Insert match keywordPUTPOSTDELETEGET
      : {Table of ModeClassPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "class-name": "string", Class name
            : {Enter proxy or server profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "mode": "enumeration" Specify mode
Options:
 server
 proxy 
            }
          }
        ]
      },      : {Specify match optionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "opt60": "integer", none
            : {Enter a profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "profile-mode": "integer" none 
            },
            "opt60-hex-str": "string", Enter hex pattern string
            "format": "integer" Set constant integer 
          }
        ]
      }
    },    : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
      "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
      "remote-id": "string" Enter remote-id value
    },    : {Default match optionPUTPOSTDELETEGET
      : {Enter server profilePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "default-mode": "enumeration" Specify mode
Options:
 server 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Delete operation of resource: base

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Retrieve operation of resource: base

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

base_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP Base ProfilePUTPOSTDELETEGET
    "enable": [ null ], Enable the DHCP IPv4 Base Profile
    : {Enable the default profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "profile-mode": "integer" none 
    },    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option": "integer", No description
range: "1..255" 
          "option-all": "integer" option all 
        }
      }
    },    : [Insert match keywordPUTPOSTDELETEGET
      {        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchoption": "integer", Match option 60 
              "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
              "format": "integer" Set constant integer 
            }
          ]
        },        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "def-matchoption": "integer" Match option 60 
            }
          ]
        }
      }
    ],    : {Insert match keywordPUTPOSTDELETEGET
      : {Table of ModeClassPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "class-name": "string", Class name
            : {Enter proxy or server profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "mode": "enumeration" Specify mode
Options:
 server
 proxy 
            }
          }
        ]
      },      : {Specify match optionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "opt60": "integer", none
            : {Enter a profilePUTPOSTDELETEGET
              "profile-name": "string", Profile name
              "profile-mode": "integer" none 
            },
            "opt60-hex-str": "string", Enter hex pattern string
            "format": "integer" Set constant integer 
          }
        ]
      }
    },    : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
      "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
      "remote-id": "string" Enter remote-id value
    },    : {Default match optionPUTPOSTDELETEGET
      : {Enter server profilePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "default-mode": "enumeration" Specify mode
Options:
 server 
      }
    }
  }
}

DEFAULT-PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Update operation of resource: default-profile

default-profile_schema

default-profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable the default profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "profile-mode": "integer" none 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Create operation of resource: default-profile

default-profile_schema

default-profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable the default profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "profile-mode": "integer" none 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Delete operation of resource: default-profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Retrieve operation of resource: default-profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

default-profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enable the default profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "profile-mode": "integer" none 
  }
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Update operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchoption": "integer", Match option 60 
          "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
          "format": "integer" Set constant integer 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "def-matchoption": "integer" Match option 60 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Create operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchoption": "integer", Match option 60 
          "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
          "format": "integer" Set constant integer 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "def-matchoption": "integer" Match option 60 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Delete operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Retrieve operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchoption": "integer", Match option 60 
          "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
          "format": "integer" Set constant integer 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "def-matchoption": "integer" Match option 60 
        }
      ]
    }
  }
}

OPTION-FILTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Update operation of resource: option-filters

option-filters_schema

option-filtersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchoption": "integer", Match option 60 
        "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Create operation of resource: option-filters

option-filters_schema

option-filtersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchoption": "integer", Match option 60 
        "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Delete operation of resource: option-filters

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Retrieve operation of resource: option-filters

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

option-filters_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchoption": "integer", Match option 60 
        "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

OPTION-FILTER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Update operation of resource: option-filter

option-filter_schema

option-filterbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "pattern": "string", Enter hex pattern string
      "matchoption": "integer", Match option 60 
      "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
      "format": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Create operation of resource: option-filter

option-filter_schema

option-filterbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "pattern": "string", Enter hex pattern string
      "matchoption": "integer", Match option 60 
      "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
      "format": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Delete operation of resource: option-filter

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Retrieve operation of resource: option-filter

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

200 OK

option-filter_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {
      "pattern": "string", Enter hex pattern string
      "matchoption": "integer", Match option 60 
      "option-action": "enumeration", Vendor action
Options:
 allow
 drop 
      "format": "integer" Set constant integer 
    }
  ]
}

DEF-OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Update operation of resource: def-options

def-options_schema

def-optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "def-matchoption": "integer" Match option 60 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Create operation of resource: def-options

def-options_schema

def-optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "def-matchoption": "integer" Match option 60 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Delete operation of resource: def-options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Retrieve operation of resource: def-options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

def-options_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "def-matchoption": "integer" Match option 60 
      }
    ]
  }
}

DEF-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Update operation of resource: def-option

def-option_schema

def-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
      "def-matchoption": "integer" Match option 60 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Create operation of resource: def-option

def-option_schema

def-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
      "def-matchoption": "integer" Match option 60 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Delete operation of resource: def-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Retrieve operation of resource: def-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

200 OK

def-option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {
      "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
      "def-matchoption": "integer" Match option 60 
    }
  ]
}

BASE-RELAY-OPT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Update operation of resource: base-relay-opt

base-relay-opt_schema

base-relay-optbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
    "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
    "remote-id": "string" Enter remote-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-RELAY-OPT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Create operation of resource: base-relay-opt

base-relay-opt_schema

base-relay-optbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
    "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
    "remote-id": "string" Enter remote-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-RELAY-OPT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Delete operation of resource: base-relay-opt

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-RELAY-OPT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Retrieve operation of resource: base-relay-opt

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

base-relay-opt_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Insert Relay Agent Information circuit ID\nand remote ID suboptions in client requestPUTPOSTDELETEGET
    "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate 
    "remote-id": "string" Enter remote-id value
  }
}

DHCP-TO-AAA - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/

Update operation of resource: dhcp-to-aaa

dhcp-to-aaa_schema

dhcp-to-aaabody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option": "integer", List of options
range: "1..255" 
        "option-all": "integer" option all 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/

Create operation of resource: dhcp-to-aaa

dhcp-to-aaa_schema

dhcp-to-aaabody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option": "integer", List of options
range: "1..255" 
        "option-all": "integer" option all 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/

Delete operation of resource: dhcp-to-aaa

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/

Retrieve operation of resource: dhcp-to-aaa

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

dhcp-to-aaa_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option": "integer", List of options
range: "1..255" 
        "option-all": "integer" option all 
      }
    }
  }
}

BASE-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/

Update operation of resource: base-option

base-option_schema

base-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option": "integer", List of options
range: "1..255" 
      "option-all": "integer" option all 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/

Create operation of resource: base-option

base-option_schema

base-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option": "integer", List of options
range: "1..255" 
      "option-all": "integer" option all 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/

Delete operation of resource: base-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/

Retrieve operation of resource: base-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

base-option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option": "integer", List of options
range: "1..255" 
      "option-all": "integer" option all 
    }
  }
}

LIST - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/list/

Update operation of resource: list

list_schema

listbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of optionsPUTPOSTDELETEGET
    "option": "integer", List of options
range: "1..255" 
    "option-all": "integer" option all 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/list/

Create operation of resource: list

list_schema

listbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of optionsPUTPOSTDELETEGET
    "option": "integer", List of options
range: "1..255" 
    "option-all": "integer" option all 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/list/

Delete operation of resource: list

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/dhcp-to-aaa/base-option/list/

Retrieve operation of resource: list

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

list_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {List of optionsPUTPOSTDELETEGET
    "option": "integer", List of options
range: "1..255" 
    "option-all": "integer" option all 
  }
}

BASE-MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Update operation of resource: base-match

base-match_schema

base-matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of ModeClassPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "class-name": "string", Class name
          : {Enter proxy or server profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "mode": "enumeration" Specify mode
Options:
 server
 proxy 
          }
        }
      ]
    },    : {Specify match optionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "opt60": "integer", none
          : {Enter a profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "profile-mode": "integer" none 
          },
          "opt60-hex-str": "string", Enter hex pattern string
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Create operation of resource: base-match

base-match_schema

base-matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of ModeClassPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "class-name": "string", Class name
          : {Enter proxy or server profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "mode": "enumeration" Specify mode
Options:
 server
 proxy 
          }
        }
      ]
    },    : {Specify match optionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "opt60": "integer", none
          : {Enter a profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "profile-mode": "integer" none 
          },
          "opt60-hex-str": "string", Enter hex pattern string
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Delete operation of resource: base-match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Retrieve operation of resource: base-match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

base-match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of ModeClassPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "class-name": "string", Class name
          : {Enter proxy or server profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "mode": "enumeration" Specify mode
Options:
 server
 proxy 
          }
        }
      ]
    },    : {Specify match optionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "opt60": "integer", none
          : {Enter a profilePUTPOSTDELETEGET
            "profile-name": "string", Profile name
            "profile-mode": "integer" none 
          },
          "opt60-hex-str": "string", Enter hex pattern string
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Update operation of resource: options

options_schema

optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify match optionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "opt60": "integer", none
        : {Enter a profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "profile-mode": "integer" none 
        },
        "opt60-hex-str": "string", Enter hex pattern string
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Create operation of resource: options

options_schema

optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify match optionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "opt60": "integer", none
        : {Enter a profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "profile-mode": "integer" none 
        },
        "opt60-hex-str": "string", Enter hex pattern string
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Delete operation of resource: options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Retrieve operation of resource: options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

options_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Specify match optionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "opt60": "integer", none
        : {Enter a profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "profile-mode": "integer" none 
        },
        "opt60-hex-str": "string", Enter hex pattern string
        "format": "integer" Set constant integer 
      }
    ]
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Update operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "opt60": "integer", none
      : {Enter a profilePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "profile-mode": "integer" none 
      },
      "opt60-hex-str": "string", Enter hex pattern string
      "format": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Create operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "opt60": "integer", none
      : {Enter a profilePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "profile-mode": "integer" none 
      },
      "opt60-hex-str": "string", Enter hex pattern string
      "format": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Delete operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Retrieve operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

200 OK

option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {
      "opt60": "integer", none
      : {Enter a profilePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "profile-mode": "integer" none 
      },
      "opt60-hex-str": "string", Enter hex pattern string
      "format": "integer" Set constant integer 
    }
  ]
}

OPTION-PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Update operation of resource: option-profile

option-profile_schema

option-profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json

Request Example

{  : {Enter a profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "profile-mode": "integer" none 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Create operation of resource: option-profile

option-profile_schema

option-profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json

Request Example

{  : {Enter a profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "profile-mode": "integer" none 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Delete operation of resource: option-profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Retrieve operation of resource: option-profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

opt60 opt60-hex-str format: string

in path

ID of opt60 opt60-hex-str format

200 OK

option-profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enter a profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "profile-mode": "integer" none 
  }
}

MODE-CLASSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/

Update operation of resource: mode-classes

mode-classes_schema

mode-classesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of ModeClassPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "class-name": "string", Class name
        : {Enter proxy or server profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "mode": "enumeration" Specify mode
Options:
 server
 proxy 
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE-CLASSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/

Create operation of resource: mode-classes

mode-classes_schema

mode-classesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of ModeClassPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "class-name": "string", Class name
        : {Enter proxy or server profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "mode": "enumeration" Specify mode
Options:
 server
 proxy 
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE-CLASSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/

Delete operation of resource: mode-classes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE-CLASSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/

Retrieve operation of resource: mode-classes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

mode-classes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of ModeClassPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "class-name": "string", Class name
        : {Enter proxy or server profilePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "mode": "enumeration" Specify mode
Options:
 server
 proxy 
        }
      }
    ]
  }
}

MODE-CLASS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/

Update operation of resource: mode-class

mode-class_schema

mode-classbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "class-name": "string", Class name
    : {Enter proxy or server profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "mode": "enumeration" Specify mode
Options:
 server
 proxy 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE-CLASS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/

Create operation of resource: mode-class

mode-class_schema

mode-classbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "class-name": "string", Class name
    : {Enter proxy or server profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "mode": "enumeration" Specify mode
Options:
 server
 proxy 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE-CLASS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/

Delete operation of resource: mode-class

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE-CLASS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/

Retrieve operation of resource: mode-class

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

mode-class_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "class-name": "string", Class name
    : {Enter proxy or server profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "mode": "enumeration" Specify mode
Options:
 server
 proxy 
    }
  }
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/profile/

Update operation of resource: profile

profile_schema

profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Enter proxy or server profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "mode": "enumeration" Specify mode
Options:
 server
 proxy 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/profile/

Create operation of resource: profile

profile_schema

profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Enter proxy or server profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "mode": "enumeration" Specify mode
Options:
 server
 proxy 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/profile/

Delete operation of resource: profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/mode-classes/mode-class/{class-name}/profile/

Retrieve operation of resource: profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enter proxy or server profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "mode": "enumeration" Specify mode
Options:
 server
 proxy 
  }
}

MATCH-DEFAULT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/

Update operation of resource: match-default

match-default_schema

match-defaultbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Default match optionPUTPOSTDELETEGET
    : {Enter server profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "default-mode": "enumeration" Specify mode
Options:
 server 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH-DEFAULT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/

Create operation of resource: match-default

match-default_schema

match-defaultbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Default match optionPUTPOSTDELETEGET
    : {Enter server profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "default-mode": "enumeration" Specify mode
Options:
 server 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH-DEFAULT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/

Delete operation of resource: match-default

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH-DEFAULT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/

Retrieve operation of resource: match-default

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

match-default_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Default match optionPUTPOSTDELETEGET
    : {Enter server profilePUTPOSTDELETEGET
      "profile-name": "string", Profile name
      "default-mode": "enumeration" Specify mode
Options:
 server 
    }
  }
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/profile/

Update operation of resource: profile

profile_schema

profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enter server profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "default-mode": "enumeration" Specify mode
Options:
 server 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/profile/

Create operation of resource: profile

profile_schema

profilebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enter server profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "default-mode": "enumeration" Specify mode
Options:
 server 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/profile/

Delete operation of resource: profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match-default/profile/

Retrieve operation of resource: profile

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enter server profilePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "default-mode": "enumeration" Specify mode
Options:
 server 
  }
}

SERVER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Update operation of resource: server

server_schema

serverbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Server profilePUTPOSTDELETEGET
    : {NetBIOS node typePUTPOSTDELETEGET
      "hybrid-node": "string", Set string
      "mixed-node": "string", Set string
      "hexadecimal": "string", Hexadecimal number
      "broadcast-node": "string", Set string
      "peer-to-peer-node": "string" Set string
    },
    "subnet-mask": "string", Configure Subnet Mask
    "domain-name": "string", Domain name
    "boot-filename": "string", Boot Filename
    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option-number": "integer", Option number 
          "option-all": "integer" Set constant integer 
        }
      }
    },
    "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
    "next-server": "string", Configure the tftp-server IP to be used\nby the client
    : [Validate server ID checkPUTPOSTDELETEGET
      {
        "check": [ null ] specify requested-ip-address-check disable
      }
    ],
    "server-allow-move": [ null ], Allow dhcp subscriber move
    : {Specify limit leasePUTPOSTDELETEGET
      "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
      "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
    },
    "secure-arp": [ null ], Enable Secure Arp
    : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
      "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
    },    : {DNS serversPUTPOSTDELETEGET
      "dns-server": "string" DNS Server's IP address
    },
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    : [NonePUTPOSTDELETEGET
      {
        "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
      }
    ],    : {NetBIOS name serversPUTPOSTDELETEGET
      "net-bios-name-server": "string" NetBIOSNameServer's IP address
    },
    "pool": "string", Specify the pool
    : [Change sessions configurationPUTPOSTDELETEGET
      {        : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
          : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
            "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
            "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
            "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
          }
        }
      }
    ],    : {default routersPUTPOSTDELETEGET
      "default-router": "string" Router's IP address
    },    : [Insert match keywordPUTPOSTDELETEGET
      {        : {Table of OptionDefaultPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
            }
          ]
        },        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
              "format": "integer" Set constant integer 
            }
          ]
        }
      }
    ],    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
      : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
        "force-insert": [ null ] Set constant integer
      }
    },    : {Validate Requested IP AddressPUTPOSTDELETEGET
      "check": [ null ] specify requested-ip-address-check disable
    },    : {Table of ClassPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {NetBIOS name serversPUTPOSTDELETEGET
            "net-bios-name-server": "string" NetBIOSNameServer's IP address
          },          : [Insert match keywordPUTPOSTDELETEGET
            {
              "l2-interface": "string", Specify match l2-interface
              : {Table of Class-OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    "bit-mask": "string" Enter bit mask pattern string
                  }
                ]
              },
              "vrf": "string" Specify match VRF
            }
          ],          : {default routersPUTPOSTDELETEGET
            "default-router": "string" Router's IP address
          },          : [Table of OptionCodePUTPOSTDELETEGET
            {              : [DHCP option codePUTPOSTDELETEGET
                {
                  "option-code": "integer", DHCP option code
range: "0..255" 
                  "hex-string": "string", Hexadecimal string
                  "ascii-string": "string", ASCII string
                  "ip-address": "string", Server's IP address
                  "force-insert": "integer" Set constant integer 
                }
              ]
            }
          ],
          "subnet-mask": "string", Configure Subnet Mask
          "boot-filename": "string", Boot Filename
          "class-name": "string", class name
          "domain-name": "string", Domain name
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          "next-server": "string", Configure the tftp-server IP to be used\nby the client
          : [NetBIOS node typePUTPOSTDELETEGET
            {
              "hybrid-node": "string", Set string
              "mixed-node": "string", Set string
              "hexadecimal": "string", Hexadecimal number
              "broadcast-node": "string", Set string
              "peer-to-peer-node": "string" Set string
            }
          ],          : {DNS serversPUTPOSTDELETEGET
            "dns-server": "string" DNS Server's IP address
          },
          "pool": "string", Specify the pool
          : [leasePUTPOSTDELETEGET
            {
              "infinite": "string", Set string
              "hours": "integer", Hours
range: "0..23"
units: "hour" 
              "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
              "days": "integer" Days
range: "0..365"
units: "day" 
            }
          ]
        }
      ]
    },    : {Table of OptionCodePUTPOSTDELETEGET
      : [DHCP option codePUTPOSTDELETEGET
        {
          "option-code": "integer", DHCP option code
range: "0..255" 
          "hex-string": "string", Hexadecimal string
          "ascii-string": "string", ASCII string
          "ip-address": "string", Server's IP address
          "force-insert": "integer" Set constant integer 
        }
      ]
    },    : [leasePUTPOSTDELETEGET
      {
        "infinite": "string", Set string
        "hours": "integer", Hours
range: "0..23"
units: "hour" 
        "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
        "days": "integer" Days
range: "0..365"
units: "day" 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Create operation of resource: server

server_schema

serverbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Server profilePUTPOSTDELETEGET
    : {NetBIOS node typePUTPOSTDELETEGET
      "hybrid-node": "string", Set string
      "mixed-node": "string", Set string
      "hexadecimal": "string", Hexadecimal number
      "broadcast-node": "string", Set string
      "peer-to-peer-node": "string" Set string
    },
    "subnet-mask": "string", Configure Subnet Mask
    "domain-name": "string", Domain name
    "boot-filename": "string", Boot Filename
    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option-number": "integer", Option number 
          "option-all": "integer" Set constant integer 
        }
      }
    },
    "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
    "next-server": "string", Configure the tftp-server IP to be used\nby the client
    : [Validate server ID checkPUTPOSTDELETEGET
      {
        "check": [ null ] specify requested-ip-address-check disable
      }
    ],
    "server-allow-move": [ null ], Allow dhcp subscriber move
    : {Specify limit leasePUTPOSTDELETEGET
      "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
      "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
    },
    "secure-arp": [ null ], Enable Secure Arp
    : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
      "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
    },    : {DNS serversPUTPOSTDELETEGET
      "dns-server": "string" DNS Server's IP address
    },
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    : [NonePUTPOSTDELETEGET
      {
        "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
      }
    ],    : {NetBIOS name serversPUTPOSTDELETEGET
      "net-bios-name-server": "string" NetBIOSNameServer's IP address
    },
    "pool": "string", Specify the pool
    : [Change sessions configurationPUTPOSTDELETEGET
      {        : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
          : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
            "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
            "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
            "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
          }
        }
      }
    ],    : {default routersPUTPOSTDELETEGET
      "default-router": "string" Router's IP address
    },    : [Insert match keywordPUTPOSTDELETEGET
      {        : {Table of OptionDefaultPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
            }
          ]
        },        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
              "format": "integer" Set constant integer 
            }
          ]
        }
      }
    ],    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
      : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
        "force-insert": [ null ] Set constant integer
      }
    },    : {Validate Requested IP AddressPUTPOSTDELETEGET
      "check": [ null ] specify requested-ip-address-check disable
    },    : {Table of ClassPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {NetBIOS name serversPUTPOSTDELETEGET
            "net-bios-name-server": "string" NetBIOSNameServer's IP address
          },          : [Insert match keywordPUTPOSTDELETEGET
            {
              "l2-interface": "string", Specify match l2-interface
              : {Table of Class-OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    "bit-mask": "string" Enter bit mask pattern string
                  }
                ]
              },
              "vrf": "string" Specify match VRF
            }
          ],          : {default routersPUTPOSTDELETEGET
            "default-router": "string" Router's IP address
          },          : [Table of OptionCodePUTPOSTDELETEGET
            {              : [DHCP option codePUTPOSTDELETEGET
                {
                  "option-code": "integer", DHCP option code
range: "0..255" 
                  "hex-string": "string", Hexadecimal string
                  "ascii-string": "string", ASCII string
                  "ip-address": "string", Server's IP address
                  "force-insert": "integer" Set constant integer 
                }
              ]
            }
          ],
          "subnet-mask": "string", Configure Subnet Mask
          "boot-filename": "string", Boot Filename
          "class-name": "string", class name
          "domain-name": "string", Domain name
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          "next-server": "string", Configure the tftp-server IP to be used\nby the client
          : [NetBIOS node typePUTPOSTDELETEGET
            {
              "hybrid-node": "string", Set string
              "mixed-node": "string", Set string
              "hexadecimal": "string", Hexadecimal number
              "broadcast-node": "string", Set string
              "peer-to-peer-node": "string" Set string
            }
          ],          : {DNS serversPUTPOSTDELETEGET
            "dns-server": "string" DNS Server's IP address
          },
          "pool": "string", Specify the pool
          : [leasePUTPOSTDELETEGET
            {
              "infinite": "string", Set string
              "hours": "integer", Hours
range: "0..23"
units: "hour" 
              "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
              "days": "integer" Days
range: "0..365"
units: "day" 
            }
          ]
        }
      ]
    },    : {Table of OptionCodePUTPOSTDELETEGET
      : [DHCP option codePUTPOSTDELETEGET
        {
          "option-code": "integer", DHCP option code
range: "0..255" 
          "hex-string": "string", Hexadecimal string
          "ascii-string": "string", ASCII string
          "ip-address": "string", Server's IP address
          "force-insert": "integer" Set constant integer 
        }
      ]
    },    : [leasePUTPOSTDELETEGET
      {
        "infinite": "string", Set string
        "hours": "integer", Hours
range: "0..23"
units: "hour" 
        "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
        "days": "integer" Days
range: "0..365"
units: "day" 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Delete operation of resource: server

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Retrieve operation of resource: server

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

server_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP Server profilePUTPOSTDELETEGET
    : {NetBIOS node typePUTPOSTDELETEGET
      "hybrid-node": "string", Set string
      "mixed-node": "string", Set string
      "hexadecimal": "string", Hexadecimal number
      "broadcast-node": "string", Set string
      "peer-to-peer-node": "string" Set string
    },
    "subnet-mask": "string", Configure Subnet Mask
    "domain-name": "string", Domain name
    "boot-filename": "string", Boot Filename
    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option-number": "integer", Option number 
          "option-all": "integer" Set constant integer 
        }
      }
    },
    "arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
    "next-server": "string", Configure the tftp-server IP to be used\nby the client
    : [Validate server ID checkPUTPOSTDELETEGET
      {
        "check": [ null ] specify requested-ip-address-check disable
      }
    ],
    "server-allow-move": [ null ], Allow dhcp subscriber move
    : {Specify limit leasePUTPOSTDELETEGET
      "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
      "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
    },
    "secure-arp": [ null ], Enable Secure Arp
    : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
      "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
    },    : {DNS serversPUTPOSTDELETEGET
      "dns-server": "string" DNS Server's IP address
    },
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    : [NonePUTPOSTDELETEGET
      {
        "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
      }
    ],    : {NetBIOS name serversPUTPOSTDELETEGET
      "net-bios-name-server": "string" NetBIOSNameServer's IP address
    },
    "pool": "string", Specify the pool
    : [Change sessions configurationPUTPOSTDELETEGET
      {        : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
          : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
            "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
            "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
            "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
          }
        }
      }
    ],    : {default routersPUTPOSTDELETEGET
      "default-router": "string" Router's IP address
    },    : [Insert match keywordPUTPOSTDELETEGET
      {        : {Table of OptionDefaultPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "matchoption": "enumeration" Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
            }
          ]
        },        : {Table of OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
              "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
              "format": "integer" Set constant integer 
            }
          ]
        }
      }
    ],    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
      : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
        "force-insert": [ null ] Set constant integer
      }
    },    : {Validate Requested IP AddressPUTPOSTDELETEGET
      "check": [ null ] specify requested-ip-address-check disable
    },    : {Table of ClassPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {NetBIOS name serversPUTPOSTDELETEGET
            "net-bios-name-server": "string" NetBIOSNameServer's IP address
          },          : [Insert match keywordPUTPOSTDELETEGET
            {
              "l2-interface": "string", Specify match l2-interface
              : {Table of Class-OptionPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "pattern": "string", Enter hex pattern string
                    "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                    "bit-mask": "string" Enter bit mask pattern string
                  }
                ]
              },
              "vrf": "string" Specify match VRF
            }
          ],          : {default routersPUTPOSTDELETEGET
            "default-router": "string" Router's IP address
          },          : [Table of OptionCodePUTPOSTDELETEGET
            {              : [DHCP option codePUTPOSTDELETEGET
                {
                  "option-code": "integer", DHCP option code
range: "0..255" 
                  "hex-string": "string", Hexadecimal string
                  "ascii-string": "string", ASCII string
                  "ip-address": "string", Server's IP address
                  "force-insert": "integer" Set constant integer 
                }
              ]
            }
          ],
          "subnet-mask": "string", Configure Subnet Mask
          "boot-filename": "string", Boot Filename
          "class-name": "string", class name
          "domain-name": "string", Domain name
          "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
          "next-server": "string", Configure the tftp-server IP to be used\nby the client
          : [NetBIOS node typePUTPOSTDELETEGET
            {
              "hybrid-node": "string", Set string
              "mixed-node": "string", Set string
              "hexadecimal": "string", Hexadecimal number
              "broadcast-node": "string", Set string
              "peer-to-peer-node": "string" Set string
            }
          ],          : {DNS serversPUTPOSTDELETEGET
            "dns-server": "string" DNS Server's IP address
          },
          "pool": "string", Specify the pool
          : [leasePUTPOSTDELETEGET
            {
              "infinite": "string", Set string
              "hours": "integer", Hours
range: "0..23"
units: "hour" 
              "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
              "days": "integer" Days
range: "0..365"
units: "day" 
            }
          ]
        }
      ]
    },    : {Table of OptionCodePUTPOSTDELETEGET
      : [DHCP option codePUTPOSTDELETEGET
        {
          "option-code": "integer", DHCP option code
range: "0..255" 
          "hex-string": "string", Hexadecimal string
          "ascii-string": "string", ASCII string
          "ip-address": "string", Server's IP address
          "force-insert": "integer" Set constant integer 
        }
      ]
    },    : [leasePUTPOSTDELETEGET
      {
        "infinite": "string", Set string
        "hours": "integer", Hours
range: "0..23"
units: "hour" 
        "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
        "days": "integer" Days
range: "0..365"
units: "day" 
      }
    ]
  }
}

SERVER-ID-CHECK - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Update operation of resource: server-id-check

server-id-check_schema

server-id-checkbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Validate server ID checkPUTPOSTDELETEGET
    "check": [ null ] specify server-id-check disable
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-ID-CHECK - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Create operation of resource: server-id-check

server-id-check_schema

server-id-checkbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Validate server ID checkPUTPOSTDELETEGET
    "check": [ null ] specify server-id-check disable
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-ID-CHECK - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Delete operation of resource: server-id-check

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-ID-CHECK - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Retrieve operation of resource: server-id-check

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

server-id-check_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Validate server ID checkPUTPOSTDELETEGET
    "check": [ null ] specify server-id-check disable
  }
}

LEASE-LIMIT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Update operation of resource: lease-limit

lease-limit_schema

lease-limitbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify limit leasePUTPOSTDELETEGET
    "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
    "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-LIMIT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Create operation of resource: lease-limit

lease-limit_schema

lease-limitbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify limit leasePUTPOSTDELETEGET
    "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
    "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-LIMIT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Delete operation of resource: lease-limit

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-LIMIT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Retrieve operation of resource: lease-limit

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

lease-limit_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Specify limit leasePUTPOSTDELETEGET
    "range": "integer", Value of limit lease count in Decimal
range: "1..240000" 
    "lease-limit-value": "enumeration" Configure Lease limit value
Options:
 per-interface
 per-circuit-id
 per-remote-id 
  }
}

REQUESTED-IP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Update operation of resource: requested-ip-address

requested-ip-address_schema

requested-ip-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Validate Requested IP AddressPUTPOSTDELETEGET
    "check": [ null ] specify requested-ip-address-check disable
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUESTED-IP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Create operation of resource: requested-ip-address

requested-ip-address_schema

requested-ip-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Validate Requested IP AddressPUTPOSTDELETEGET
    "check": [ null ] specify requested-ip-address-check disable
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUESTED-IP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Delete operation of resource: requested-ip-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUESTED-IP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Retrieve operation of resource: requested-ip-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

requested-ip-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Validate Requested IP AddressPUTPOSTDELETEGET
    "check": [ null ] specify requested-ip-address-check disable
  }
}

AAA-SERVER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Update operation of resource: aaa-server

aaa-server_schema

aaa-serverbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
      "force-insert": [ null ] Enable aaa dhcp option force-insert
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AAA-SERVER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Create operation of resource: aaa-server

aaa-server_schema

aaa-serverbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
      "force-insert": [ null ] Enable aaa dhcp option force-insert
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AAA-SERVER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Delete operation of resource: aaa-server

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AAA-SERVER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Retrieve operation of resource: aaa-server

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

aaa-server_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
    : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
      "force-insert": [ null ] Enable aaa dhcp option force-insert
    }
  }
}

DHCP-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Update operation of resource: dhcp-option

dhcp-option_schema

dhcp-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
    "force-insert": [ null ] Enable aaa dhcp option force-insert
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Create operation of resource: dhcp-option

dhcp-option_schema

dhcp-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
    "force-insert": [ null ] Enable aaa dhcp option force-insert
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Delete operation of resource: dhcp-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Retrieve operation of resource: dhcp-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

dhcp-option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enable aaa dhcp option force-insertPUTPOSTDELETEGET
    "force-insert": [ null ] Enable aaa dhcp option force-insert
  }
}

DEFAULT-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Update operation of resource: default-routers

default-routers_schema

default-routersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {default routersPUTPOSTDELETEGET
    "default-router": "string" Router's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Create operation of resource: default-routers

default-routers_schema

default-routersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {default routersPUTPOSTDELETEGET
    "default-router": "string" Router's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Delete operation of resource: default-routers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Retrieve operation of resource: default-routers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

default-routers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {default routersPUTPOSTDELETEGET
    "default-router": "string" Router's IP address
  }
}

NET-BIOS-NAME-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Update operation of resource: net-bios-name-servers

net-bios-name-servers_schema

net-bios-name-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {NetBIOS name serversPUTPOSTDELETEGET
    "net-bios-name-server": "string" NetBIOSNameServer's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Create operation of resource: net-bios-name-servers

net-bios-name-servers_schema

net-bios-name-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {NetBIOS name serversPUTPOSTDELETEGET
    "net-bios-name-server": "string" NetBIOSNameServer's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Delete operation of resource: net-bios-name-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Retrieve operation of resource: net-bios-name-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

net-bios-name-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {NetBIOS name serversPUTPOSTDELETEGET
    "net-bios-name-server": "string" NetBIOSNameServer's IP address
  }
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Update operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionDefaultPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Create operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionDefaultPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Delete operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Retrieve operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionDefaultPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
          "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

OPTION-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Update operation of resource: option-defaults

option-defaults_schema

option-defaultsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionDefaultPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Create operation of resource: option-defaults

option-defaults_schema

option-defaultsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionDefaultPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Delete operation of resource: option-defaults

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Retrieve operation of resource: option-defaults

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

option-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionDefaultPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
      }
    ]
  }
}

OPTION-DEFAULT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Update operation of resource: option-default

option-default_schema

option-defaultbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption: string

in path

ID of matchoption

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
      "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Create operation of resource: option-default

option-default_schema

option-defaultbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption: string

in path

ID of matchoption

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
      "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Delete operation of resource: option-default

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption: string

in path

ID of matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Retrieve operation of resource: option-default

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption: string

in path

ID of matchoption

200 OK

option-default_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {
      "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
      "matchoption": "enumeration" Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
    }
  ]
}

OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Update operation of resource: options

options_schema

optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Create operation of resource: options

options_schema

optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Delete operation of resource: options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Retrieve operation of resource: options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

options_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
        "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Update operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "pattern": "string", Enter hex pattern string
    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
    "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
    "format": "integer" Set constant integer 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Create operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "pattern": "string", Enter hex pattern string
    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
    "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
    "format": "integer" Set constant integer 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Delete operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Retrieve operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

200 OK

option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "pattern": "string", Enter hex pattern string
    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop 
    "matchoption": "enumeration", Match option 60
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
    "format": "integer" Set constant integer 
  }
}

BROADCAST-FLAG - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Update operation of resource: broadcast-flag

broadcast-flag_schema

broadcast-flagbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {NonePUTPOSTDELETEGET
    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Create operation of resource: broadcast-flag

broadcast-flag_schema

broadcast-flagbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {NonePUTPOSTDELETEGET
    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Delete operation of resource: broadcast-flag

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Retrieve operation of resource: broadcast-flag

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

broadcast-flag_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {NonePUTPOSTDELETEGET
    "policy": "enumeration" Specify broadcast flag policy
Options:
 ignore
 check
 unicastalways 
  }
}

SESSION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Update operation of resource: session

session_schema

sessionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Change sessions configurationPUTPOSTDELETEGET
    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Create operation of resource: session

session_schema

sessionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Change sessions configurationPUTPOSTDELETEGET
    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Delete operation of resource: session

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Retrieve operation of resource: session

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

session_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Change sessions configurationPUTPOSTDELETEGET
    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
      }
    }
  }
}

THROTTLE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Update operation of resource: throttle-type

throttle-type_schema

throttle-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THROTTLE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Create operation of resource: throttle-type

throttle-type_schema

throttle-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THROTTLE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Delete operation of resource: throttle-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THROTTLE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Retrieve operation of resource: throttle-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

throttle-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
    }
  }
}

MAC-THROTTLE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Update operation of resource: mac-throttle

mac-throttle_schema

mac-throttlebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-THROTTLE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Create operation of resource: mac-throttle

mac-throttle_schema

mac-throttlebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-THROTTLE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Delete operation of resource: mac-throttle

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-THROTTLE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Retrieve operation of resource: mac-throttle

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

mac-throttle_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
  }
}

CLASSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Update operation of resource: classes

classes_schema

classesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of ClassPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {NetBIOS name serversPUTPOSTDELETEGET
          "net-bios-name-server": "string" NetBIOSNameServer's IP address
        },        : [Insert match keywordPUTPOSTDELETEGET
          {
            "l2-interface": "string", Specify match l2-interface
            : {Table of Class-OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  "bit-mask": "string" Enter bit mask pattern string
                }
              ]
            },
            "vrf": "string" Specify match VRF
          }
        ],        : {default routersPUTPOSTDELETEGET
          "default-router": "string" Router's IP address
        },        : [Table of OptionCodePUTPOSTDELETEGET
          {            : [DHCP option codePUTPOSTDELETEGET
              {
                "option-code": "integer", DHCP option code
range: "0..255" 
                "hex-string": "string", Hexadecimal string
                "ascii-string": "string", ASCII string
                "ip-address": "string", Server's IP address
                "force-insert": "integer" Set constant integer 
              }
            ]
          }
        ],
        "subnet-mask": "string", Configure Subnet Mask
        "boot-filename": "string", Boot Filename
        "class-name": "string", class name
        "domain-name": "string", Domain name
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        "next-server": "string", Configure the tftp-server IP to be used\nby the client
        : [NetBIOS node typePUTPOSTDELETEGET
          {
            "hybrid-node": "string", Set string
            "mixed-node": "string", Set string
            "hexadecimal": "string", Hexadecimal number
            "broadcast-node": "string", Set string
            "peer-to-peer-node": "string" Set string
          }
        ],        : {DNS serversPUTPOSTDELETEGET
          "dns-server": "string" DNS Server's IP address
        },
        "pool": "string", Specify the pool
        : [leasePUTPOSTDELETEGET
          {
            "infinite": "string", Set string
            "hours": "integer", Hours
range: "0..23"
units: "hour" 
            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
            "days": "integer" Days
range: "0..365"
units: "day" 
          }
        ]
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Create operation of resource: classes

classes_schema

classesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of ClassPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {NetBIOS name serversPUTPOSTDELETEGET
          "net-bios-name-server": "string" NetBIOSNameServer's IP address
        },        : [Insert match keywordPUTPOSTDELETEGET
          {
            "l2-interface": "string", Specify match l2-interface
            : {Table of Class-OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  "bit-mask": "string" Enter bit mask pattern string
                }
              ]
            },
            "vrf": "string" Specify match VRF
          }
        ],        : {default routersPUTPOSTDELETEGET
          "default-router": "string" Router's IP address
        },        : [Table of OptionCodePUTPOSTDELETEGET
          {            : [DHCP option codePUTPOSTDELETEGET
              {
                "option-code": "integer", DHCP option code
range: "0..255" 
                "hex-string": "string", Hexadecimal string
                "ascii-string": "string", ASCII string
                "ip-address": "string", Server's IP address
                "force-insert": "integer" Set constant integer 
              }
            ]
          }
        ],
        "subnet-mask": "string", Configure Subnet Mask
        "boot-filename": "string", Boot Filename
        "class-name": "string", class name
        "domain-name": "string", Domain name
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        "next-server": "string", Configure the tftp-server IP to be used\nby the client
        : [NetBIOS node typePUTPOSTDELETEGET
          {
            "hybrid-node": "string", Set string
            "mixed-node": "string", Set string
            "hexadecimal": "string", Hexadecimal number
            "broadcast-node": "string", Set string
            "peer-to-peer-node": "string" Set string
          }
        ],        : {DNS serversPUTPOSTDELETEGET
          "dns-server": "string" DNS Server's IP address
        },
        "pool": "string", Specify the pool
        : [leasePUTPOSTDELETEGET
          {
            "infinite": "string", Set string
            "hours": "integer", Hours
range: "0..23"
units: "hour" 
            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
            "days": "integer" Days
range: "0..365"
units: "day" 
          }
        ]
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Delete operation of resource: classes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Retrieve operation of resource: classes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

classes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of ClassPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {NetBIOS name serversPUTPOSTDELETEGET
          "net-bios-name-server": "string" NetBIOSNameServer's IP address
        },        : [Insert match keywordPUTPOSTDELETEGET
          {
            "l2-interface": "string", Specify match l2-interface
            : {Table of Class-OptionPUTPOSTDELETEGET
              : [No descriptionPUTPOSTDELETEGET
                {
                  "pattern": "string", Enter hex pattern string
                  "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
                  "bit-mask": "string" Enter bit mask pattern string
                }
              ]
            },
            "vrf": "string" Specify match VRF
          }
        ],        : {default routersPUTPOSTDELETEGET
          "default-router": "string" Router's IP address
        },        : [Table of OptionCodePUTPOSTDELETEGET
          {            : [DHCP option codePUTPOSTDELETEGET
              {
                "option-code": "integer", DHCP option code
range: "0..255" 
                "hex-string": "string", Hexadecimal string
                "ascii-string": "string", ASCII string
                "ip-address": "string", Server's IP address
                "force-insert": "integer" Set constant integer 
              }
            ]
          }
        ],
        "subnet-mask": "string", Configure Subnet Mask
        "boot-filename": "string", Boot Filename
        "class-name": "string", class name
        "domain-name": "string", Domain name
        "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
        "next-server": "string", Configure the tftp-server IP to be used\nby the client
        : [NetBIOS node typePUTPOSTDELETEGET
          {
            "hybrid-node": "string", Set string
            "mixed-node": "string", Set string
            "hexadecimal": "string", Hexadecimal number
            "broadcast-node": "string", Set string
            "peer-to-peer-node": "string" Set string
          }
        ],        : {DNS serversPUTPOSTDELETEGET
          "dns-server": "string" DNS Server's IP address
        },
        "pool": "string", Specify the pool
        : [leasePUTPOSTDELETEGET
          {
            "infinite": "string", Set string
            "hours": "integer", Hours
range: "0..23"
units: "hour" 
            "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
            "days": "integer" Days
range: "0..365"
units: "day" 
          }
        ]
      }
    ]
  }
}

CLASS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Update operation of resource: class

class_schema

classbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    : {NetBIOS name serversPUTPOSTDELETEGET
      "net-bios-name-server": "string" NetBIOSNameServer's IP address
    },    : [Insert match keywordPUTPOSTDELETEGET
      {
        "l2-interface": "string", Specify match l2-interface
        : {Table of Class-OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
              "bit-mask": "string" Enter bit mask pattern string
            }
          ]
        },
        "vrf": "string" Specify match VRF
      }
    ],    : {default routersPUTPOSTDELETEGET
      "default-router": "string" Router's IP address
    },    : [Table of OptionCodePUTPOSTDELETEGET
      {        : [DHCP option codePUTPOSTDELETEGET
          {
            "option-code": "integer", DHCP option code
range: "0..255" 
            "hex-string": "string", Hexadecimal string
            "ascii-string": "string", ASCII string
            "ip-address": "string", Server's IP address
            "force-insert": "integer" Set constant integer 
          }
        ]
      }
    ],
    "subnet-mask": "string", Configure Subnet Mask
    "boot-filename": "string", Boot Filename
    "class-name": "string", class name
    "domain-name": "string", Domain name
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    "next-server": "string", Configure the tftp-server IP to be used\nby the client
    : [NetBIOS node typePUTPOSTDELETEGET
      {
        "hybrid-node": "string", Set string
        "mixed-node": "string", Set string
        "hexadecimal": "string", Hexadecimal number
        "broadcast-node": "string", Set string
        "peer-to-peer-node": "string" Set string
      }
    ],    : {DNS serversPUTPOSTDELETEGET
      "dns-server": "string" DNS Server's IP address
    },
    "pool": "string", Specify the pool
    : [leasePUTPOSTDELETEGET
      {
        "infinite": "string", Set string
        "hours": "integer", Hours
range: "0..23"
units: "hour" 
        "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
        "days": "integer" Days
range: "0..365"
units: "day" 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Create operation of resource: class

class_schema

classbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    : {NetBIOS name serversPUTPOSTDELETEGET
      "net-bios-name-server": "string" NetBIOSNameServer's IP address
    },    : [Insert match keywordPUTPOSTDELETEGET
      {
        "l2-interface": "string", Specify match l2-interface
        : {Table of Class-OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
              "bit-mask": "string" Enter bit mask pattern string
            }
          ]
        },
        "vrf": "string" Specify match VRF
      }
    ],    : {default routersPUTPOSTDELETEGET
      "default-router": "string" Router's IP address
    },    : [Table of OptionCodePUTPOSTDELETEGET
      {        : [DHCP option codePUTPOSTDELETEGET
          {
            "option-code": "integer", DHCP option code
range: "0..255" 
            "hex-string": "string", Hexadecimal string
            "ascii-string": "string", ASCII string
            "ip-address": "string", Server's IP address
            "force-insert": "integer" Set constant integer 
          }
        ]
      }
    ],
    "subnet-mask": "string", Configure Subnet Mask
    "boot-filename": "string", Boot Filename
    "class-name": "string", class name
    "domain-name": "string", Domain name
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    "next-server": "string", Configure the tftp-server IP to be used\nby the client
    : [NetBIOS node typePUTPOSTDELETEGET
      {
        "hybrid-node": "string", Set string
        "mixed-node": "string", Set string
        "hexadecimal": "string", Hexadecimal number
        "broadcast-node": "string", Set string
        "peer-to-peer-node": "string" Set string
      }
    ],    : {DNS serversPUTPOSTDELETEGET
      "dns-server": "string" DNS Server's IP address
    },
    "pool": "string", Specify the pool
    : [leasePUTPOSTDELETEGET
      {
        "infinite": "string", Set string
        "hours": "integer", Hours
range: "0..23"
units: "hour" 
        "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
        "days": "integer" Days
range: "0..365"
units: "day" 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Delete operation of resource: class

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Retrieve operation of resource: class

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

class_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    : {NetBIOS name serversPUTPOSTDELETEGET
      "net-bios-name-server": "string" NetBIOSNameServer's IP address
    },    : [Insert match keywordPUTPOSTDELETEGET
      {
        "l2-interface": "string", Specify match l2-interface
        : {Table of Class-OptionPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "pattern": "string", Enter hex pattern string
              "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
              "bit-mask": "string" Enter bit mask pattern string
            }
          ]
        },
        "vrf": "string" Specify match VRF
      }
    ],    : {default routersPUTPOSTDELETEGET
      "default-router": "string" Router's IP address
    },    : [Table of OptionCodePUTPOSTDELETEGET
      {        : [DHCP option codePUTPOSTDELETEGET
          {
            "option-code": "integer", DHCP option code
range: "0..255" 
            "hex-string": "string", Hexadecimal string
            "ascii-string": "string", ASCII string
            "ip-address": "string", Server's IP address
            "force-insert": "integer" Set constant integer 
          }
        ]
      }
    ],
    "subnet-mask": "string", Configure Subnet Mask
    "boot-filename": "string", Boot Filename
    "class-name": "string", class name
    "domain-name": "string", Domain name
    "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
    "next-server": "string", Configure the tftp-server IP to be used\nby the client
    : [NetBIOS node typePUTPOSTDELETEGET
      {
        "hybrid-node": "string", Set string
        "mixed-node": "string", Set string
        "hexadecimal": "string", Hexadecimal number
        "broadcast-node": "string", Set string
        "peer-to-peer-node": "string" Set string
      }
    ],    : {DNS serversPUTPOSTDELETEGET
      "dns-server": "string" DNS Server's IP address
    },
    "pool": "string", Specify the pool
    : [leasePUTPOSTDELETEGET
      {
        "infinite": "string", Set string
        "hours": "integer", Hours
range: "0..23"
units: "hour" 
        "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
        "days": "integer" Days
range: "0..365"
units: "day" 
      }
    ]
  }
}

DEFAULT-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Update operation of resource: default-routers

default-routers_schema

default-routersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {default routersPUTPOSTDELETEGET
    "default-router": "string" Router's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Create operation of resource: default-routers

default-routers_schema

default-routersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {default routersPUTPOSTDELETEGET
    "default-router": "string" Router's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Delete operation of resource: default-routers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Retrieve operation of resource: default-routers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

default-routers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {default routersPUTPOSTDELETEGET
    "default-router": "string" Router's IP address
  }
}

NET-BIOS-NAME-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Update operation of resource: net-bios-name-servers

net-bios-name-servers_schema

net-bios-name-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {NetBIOS name serversPUTPOSTDELETEGET
    "net-bios-name-server": "string" NetBIOSNameServer's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Create operation of resource: net-bios-name-servers

net-bios-name-servers_schema

net-bios-name-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {NetBIOS name serversPUTPOSTDELETEGET
    "net-bios-name-server": "string" NetBIOSNameServer's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Delete operation of resource: net-bios-name-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Retrieve operation of resource: net-bios-name-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

net-bios-name-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {NetBIOS name serversPUTPOSTDELETEGET
    "net-bios-name-server": "string" NetBIOSNameServer's IP address
  }
}

CLASS-MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Update operation of resource: class-match

class-match_schema

class-matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    "l2-interface": "string", Specify match l2-interface
    : {Table of Class-OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
          "bit-mask": "string" Enter bit mask pattern string
        }
      ]
    },
    "vrf": "string" Specify match VRF
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Create operation of resource: class-match

class-match_schema

class-matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    "l2-interface": "string", Specify match l2-interface
    : {Table of Class-OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
          "bit-mask": "string" Enter bit mask pattern string
        }
      ]
    },
    "vrf": "string" Specify match VRF
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Delete operation of resource: class-match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Retrieve operation of resource: class-match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

class-match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Insert match keywordPUTPOSTDELETEGET
    "l2-interface": "string", Specify match l2-interface
    : {Table of Class-OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
          "bit-mask": "string" Enter bit mask pattern string
        }
      ]
    },
    "vrf": "string" Specify match VRF
  }
}

CLASS-OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Update operation of resource: class-options

class-options_schema

class-optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Table of Class-OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        "bit-mask": "string" Enter bit mask pattern string
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Create operation of resource: class-options

class-options_schema

class-optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Table of Class-OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        "bit-mask": "string" Enter bit mask pattern string
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Delete operation of resource: class-options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Retrieve operation of resource: class-options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

class-options_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of Class-OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
        "bit-mask": "string" Enter bit mask pattern string
      }
    ]
  }
}

CLASS-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Update operation of resource: class-option

class-option_schema

class-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

matchoption: string

in path

ID of matchoption

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "pattern": "string", Enter hex pattern string
      "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
      "bit-mask": "string" Enter bit mask pattern string
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Create operation of resource: class-option

class-option_schema

class-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

matchoption: string

in path

ID of matchoption

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "pattern": "string", Enter hex pattern string
      "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
      "bit-mask": "string" Enter bit mask pattern string
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Delete operation of resource: class-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

matchoption: string

in path

ID of matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Retrieve operation of resource: class-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

matchoption: string

in path

ID of matchoption

200 OK

class-option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {
      "pattern": "string", Enter hex pattern string
      "matchoption": "enumeration", Match options
Options:
 circuitid
 remoteid
 60
 77
 124
 125 
      "bit-mask": "string" Enter bit mask pattern string
    }
  ]
}

LEASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Update operation of resource: lease

lease_schema

leasebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {leasePUTPOSTDELETEGET
    "infinite": "string", Set string
    "hours": "integer", Hours
range: "0..23"
units: "hour" 
    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
    "days": "integer" Days
range: "0..365"
units: "day" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Create operation of resource: lease

lease_schema

leasebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {leasePUTPOSTDELETEGET
    "infinite": "string", Set string
    "hours": "integer", Hours
range: "0..23"
units: "hour" 
    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
    "days": "integer" Days
range: "0..365"
units: "day" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Delete operation of resource: lease

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Retrieve operation of resource: lease

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

lease_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {leasePUTPOSTDELETEGET
    "infinite": "string", Set string
    "hours": "integer", Hours
range: "0..23"
units: "hour" 
    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
    "days": "integer" Days
range: "0..365"
units: "day" 
  }
}

NETBIOS-NODE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Update operation of resource: netbios-node-type

netbios-node-type_schema

netbios-node-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {NetBIOS node typePUTPOSTDELETEGET
    "hybrid-node": "string", Set string
    "mixed-node": "string", Set string
    "hexadecimal": "string", Hexadecimal number
    "broadcast-node": "string", Set string
    "peer-to-peer-node": "string" Set string
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Create operation of resource: netbios-node-type

netbios-node-type_schema

netbios-node-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {NetBIOS node typePUTPOSTDELETEGET
    "hybrid-node": "string", Set string
    "mixed-node": "string", Set string
    "hexadecimal": "string", Hexadecimal number
    "broadcast-node": "string", Set string
    "peer-to-peer-node": "string" Set string
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Delete operation of resource: netbios-node-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Retrieve operation of resource: netbios-node-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

netbios-node-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {NetBIOS node typePUTPOSTDELETEGET
    "hybrid-node": "string", Set string
    "mixed-node": "string", Set string
    "hexadecimal": "string", Hexadecimal number
    "broadcast-node": "string", Set string
    "peer-to-peer-node": "string" Set string
  }
}

DNS-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Update operation of resource: dns-servers

dns-servers_schema

dns-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {DNS serversPUTPOSTDELETEGET
    "dns-server": "string" DNS Server's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Create operation of resource: dns-servers

dns-servers_schema

dns-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {DNS serversPUTPOSTDELETEGET
    "dns-server": "string" DNS Server's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Delete operation of resource: dns-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Retrieve operation of resource: dns-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

dns-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DNS serversPUTPOSTDELETEGET
    "dns-server": "string" DNS Server's IP address
  }
}

OPTION-CODES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Update operation of resource: option-codes

option-codes_schema

option-codesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Table of OptionCodePUTPOSTDELETEGET
    : [DHCP option codePUTPOSTDELETEGET
      {
        "option-code": "integer", DHCP option code
range: "0..255" 
        "hex-string": "string", Hexadecimal string
        "ascii-string": "string", ASCII string
        "ip-address": "string", Server's IP address
        "force-insert": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Create operation of resource: option-codes

option-codes_schema

option-codesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Table of OptionCodePUTPOSTDELETEGET
    : [DHCP option codePUTPOSTDELETEGET
      {
        "option-code": "integer", DHCP option code
range: "0..255" 
        "hex-string": "string", Hexadecimal string
        "ascii-string": "string", ASCII string
        "ip-address": "string", Server's IP address
        "force-insert": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Delete operation of resource: option-codes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Retrieve operation of resource: option-codes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

option-codes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionCodePUTPOSTDELETEGET
    : [DHCP option codePUTPOSTDELETEGET
      {
        "option-code": "integer", DHCP option code
range: "0..255" 
        "hex-string": "string", Hexadecimal string
        "ascii-string": "string", ASCII string
        "ip-address": "string", Server's IP address
        "force-insert": "integer" Set constant integer 
      }
    ]
  }
}

OPTION-CODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Update operation of resource: option-code

option-code_schema

option-codebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

option-code: string

in path

ID of option-code

Request Content-Types: application/json

Request Example

{  : [DHCP option codePUTPOSTDELETEGET
    {
      "option-code": "integer", DHCP option code
range: "0..255" 
      "hex-string": "string", Hexadecimal string
      "ascii-string": "string", ASCII string
      "ip-address": "string", Server's IP address
      "force-insert": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Create operation of resource: option-code

option-code_schema

option-codebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

option-code: string

in path

ID of option-code

Request Content-Types: application/json

Request Example

{  : [DHCP option codePUTPOSTDELETEGET
    {
      "option-code": "integer", DHCP option code
range: "0..255" 
      "hex-string": "string", Hexadecimal string
      "ascii-string": "string", ASCII string
      "ip-address": "string", Server's IP address
      "force-insert": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Delete operation of resource: option-code

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

option-code: string

in path

ID of option-code

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Retrieve operation of resource: option-code

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

option-code: string

in path

ID of option-code

200 OK

option-code_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [DHCP option codePUTPOSTDELETEGET
    {
      "option-code": "integer", DHCP option code
range: "0..255" 
      "hex-string": "string", Hexadecimal string
      "ascii-string": "string", ASCII string
      "ip-address": "string", Server's IP address
      "force-insert": "integer" Set constant integer 
    }
  ]
}

RELAY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Update operation of resource: relay

relay_schema

relaybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
    "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Create operation of resource: relay

relay_schema

relaybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
    "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Delete operation of resource: relay

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Retrieve operation of resource: relay

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

relay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Specify Relay Agent Information Option\nconfigurationPUTPOSTDELETEGET
    "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate 
  }
}

LEASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Update operation of resource: lease

lease_schema

leasebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {leasePUTPOSTDELETEGET
    "infinite": "string", Set string
    "hours": "integer", Hours
range: "0..23"
units: "hour" 
    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
    "days": "integer" Days
range: "0..365"
units: "day" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Create operation of resource: lease

lease_schema

leasebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {leasePUTPOSTDELETEGET
    "infinite": "string", Set string
    "hours": "integer", Hours
range: "0..23"
units: "hour" 
    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
    "days": "integer" Days
range: "0..365"
units: "day" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Delete operation of resource: lease

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Retrieve operation of resource: lease

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

lease_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {leasePUTPOSTDELETEGET
    "infinite": "string", Set string
    "hours": "integer", Hours
range: "0..23"
units: "hour" 
    "minutes": "integer", Minutes
range: "0..59"
units: "minute" 
    "days": "integer" Days
range: "0..365"
units: "day" 
  }
}

NETBIOS-NODE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Update operation of resource: netbios-node-type

netbios-node-type_schema

netbios-node-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {NetBIOS node typePUTPOSTDELETEGET
    "hybrid-node": "string", Set string
    "mixed-node": "string", Set string
    "hexadecimal": "string", Hexadecimal number
    "broadcast-node": "string", Set string
    "peer-to-peer-node": "string" Set string
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Create operation of resource: netbios-node-type

netbios-node-type_schema

netbios-node-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {NetBIOS node typePUTPOSTDELETEGET
    "hybrid-node": "string", Set string
    "mixed-node": "string", Set string
    "hexadecimal": "string", Hexadecimal number
    "broadcast-node": "string", Set string
    "peer-to-peer-node": "string" Set string
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Delete operation of resource: netbios-node-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Retrieve operation of resource: netbios-node-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

netbios-node-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {NetBIOS node typePUTPOSTDELETEGET
    "hybrid-node": "string", Set string
    "mixed-node": "string", Set string
    "hexadecimal": "string", Hexadecimal number
    "broadcast-node": "string", Set string
    "peer-to-peer-node": "string" Set string
  }
}

DNS-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Update operation of resource: dns-servers

dns-servers_schema

dns-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DNS serversPUTPOSTDELETEGET
    "dns-server": "string" DNS Server's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Create operation of resource: dns-servers

dns-servers_schema

dns-serversbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DNS serversPUTPOSTDELETEGET
    "dns-server": "string" DNS Server's IP address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Delete operation of resource: dns-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Retrieve operation of resource: dns-servers

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

dns-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DNS serversPUTPOSTDELETEGET
    "dns-server": "string" DNS Server's IP address
  }
}

DHCP-TO-AAA - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Update operation of resource: dhcp-to-aaa

dhcp-to-aaa_schema

dhcp-to-aaabody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option-number": "integer", Option number 
        "option-all": "integer" Set constant integer 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Create operation of resource: dhcp-to-aaa

dhcp-to-aaa_schema

dhcp-to-aaabody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option-number": "integer", Option number 
        "option-all": "integer" Set constant integer 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Delete operation of resource: dhcp-to-aaa

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Retrieve operation of resource: dhcp-to-aaa

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

dhcp-to-aaa_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option-number": "integer", Option number 
        "option-all": "integer" Set constant integer 
      }
    }
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Update operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option-number": "integer", Option number 
      "option-all": "integer" Set constant integer 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Create operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option-number": "integer", Option number 
      "option-all": "integer" Set constant integer 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Delete operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Retrieve operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option-number": "integer", Option number 
      "option-all": "integer" Set constant integer 
    }
  }
}

LIST - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Update operation of resource: list

list_schema

listbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of optionsPUTPOSTDELETEGET
    "option-number": "integer", Option number 
    "option-all": "integer" Set constant integer 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Create operation of resource: list

list_schema

listbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of optionsPUTPOSTDELETEGET
    "option-number": "integer", Option number 
    "option-all": "integer" Set constant integer 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Delete operation of resource: list

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Retrieve operation of resource: list

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

list_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {List of optionsPUTPOSTDELETEGET
    "option-number": "integer", Option number 
    "option-all": "integer" Set constant integer 
  }
}

OPTION-CODES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Update operation of resource: option-codes

option-codes_schema

option-codesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionCodePUTPOSTDELETEGET
    : [DHCP option codePUTPOSTDELETEGET
      {
        "option-code": "integer", DHCP option code
range: "0..255" 
        "hex-string": "string", Hexadecimal string
        "ascii-string": "string", ASCII string
        "ip-address": "string", Server's IP address
        "force-insert": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Create operation of resource: option-codes

option-codes_schema

option-codesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionCodePUTPOSTDELETEGET
    : [DHCP option codePUTPOSTDELETEGET
      {
        "option-code": "integer", DHCP option code
range: "0..255" 
        "hex-string": "string", Hexadecimal string
        "ascii-string": "string", ASCII string
        "ip-address": "string", Server's IP address
        "force-insert": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Delete operation of resource: option-codes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Retrieve operation of resource: option-codes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

option-codes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionCodePUTPOSTDELETEGET
    : [DHCP option codePUTPOSTDELETEGET
      {
        "option-code": "integer", DHCP option code
range: "0..255" 
        "hex-string": "string", Hexadecimal string
        "ascii-string": "string", ASCII string
        "ip-address": "string", Server's IP address
        "force-insert": "integer" Set constant integer 
      }
    ]
  }
}

OPTION-CODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Update operation of resource: option-code

option-code_schema

option-codebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

option-code: string

in path

ID of option-code

Request Content-Types: application/json

Request Example

{  : [DHCP option codePUTPOSTDELETEGET
    {
      "option-code": "integer", DHCP option code
range: "0..255" 
      "hex-string": "string", Hexadecimal string
      "ascii-string": "string", ASCII string
      "ip-address": "string", Server's IP address
      "force-insert": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Create operation of resource: option-code

option-code_schema

option-codebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

option-code: string

in path

ID of option-code

Request Content-Types: application/json

Request Example

{  : [DHCP option codePUTPOSTDELETEGET
    {
      "option-code": "integer", DHCP option code
range: "0..255" 
      "hex-string": "string", Hexadecimal string
      "ascii-string": "string", ASCII string
      "ip-address": "string", Server's IP address
      "force-insert": "integer" Set constant integer 
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Delete operation of resource: option-code

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

option-code: string

in path

ID of option-code

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Retrieve operation of resource: option-code

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

option-code: string

in path

ID of option-code

200 OK

option-code_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [DHCP option codePUTPOSTDELETEGET
    {
      "option-code": "integer", DHCP option code
range: "0..255" 
      "hex-string": "string", Hexadecimal string
      "ascii-string": "string", ASCII string
      "ip-address": "string", Server's IP address
      "force-insert": "integer" Set constant integer 
    }
  ]
}

RELAY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Update operation of resource: relay

relay_schema

relaybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Relay profilePUTPOSTDELETEGET
    : {GIADDR policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 replace
 drop 
    },    : {Broadcast Flag policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 ignore
 check
 unicast-always 
    },    : {VRF Helper AddressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF Name
          : {Helper AddressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "gateway-address": "string", GatewayAddress
                "enable": [ null ], Enable helper - deprecated
                "ip-address": "string" IPV4 Address
              }
            ]
          }
        }
      ]
    },
    "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
    : {Relay agent information optionPUTPOSTDELETEGET
      "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
      "subscriber-id": "string", Subscriber ID
      "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
      : {Enter remote-id valuePUTPOSTDELETEGET
        "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
        "remote-id-value": "string" Enter remote-id value
      },
      "allow-untrusted": [ null ], Forward untrusted packets
      "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
      "vpn": [ null ], Insert VPN options
      "check": [ null ] Check Relay Agent Information Option in\nserver reply
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Create operation of resource: relay

relay_schema

relaybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP Relay profilePUTPOSTDELETEGET
    : {GIADDR policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 replace
 drop 
    },    : {Broadcast Flag policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 ignore
 check
 unicast-always 
    },    : {VRF Helper AddressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF Name
          : {Helper AddressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "gateway-address": "string", GatewayAddress
                "enable": [ null ], Enable helper - deprecated
                "ip-address": "string" IPV4 Address
              }
            ]
          }
        }
      ]
    },
    "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
    : {Relay agent information optionPUTPOSTDELETEGET
      "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
      "subscriber-id": "string", Subscriber ID
      "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
      : {Enter remote-id valuePUTPOSTDELETEGET
        "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
        "remote-id-value": "string" Enter remote-id value
      },
      "allow-untrusted": [ null ], Forward untrusted packets
      "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
      "vpn": [ null ], Insert VPN options
      "check": [ null ] Check Relay Agent Information Option in\nserver reply
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Delete operation of resource: relay

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Retrieve operation of resource: relay

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

relay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP Relay profilePUTPOSTDELETEGET
    : {GIADDR policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 replace
 drop 
    },    : {Broadcast Flag policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 ignore
 check
 unicast-always 
    },    : {VRF Helper AddressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF Name
          : {Helper AddressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "gateway-address": "string", GatewayAddress
                "enable": [ null ], Enable helper - deprecated
                "ip-address": "string" IPV4 Address
              }
            ]
          }
        }
      ]
    },
    "mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
 forward
 drop
    : {Relay agent information optionPUTPOSTDELETEGET
      "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
      "subscriber-id": "string", Subscriber ID
      "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
      : {Enter remote-id valuePUTPOSTDELETEGET
        "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
        "remote-id-value": "string" Enter remote-id value
      },
      "allow-untrusted": [ null ], Forward untrusted packets
      "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
      "vpn": [ null ], Insert VPN options
      "check": [ null ] Check Relay Agent Information Option in\nserver reply
    }
  }
}

GI-ADDR-POLICY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Update operation of resource: gi-addr-policy

gi-addr-policy_schema

gi-addr-policybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {GIADDR policyPUTPOSTDELETEGET
    "policy": "enumeration" GIADDR policy
Options:
 replace
 drop 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GI-ADDR-POLICY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Create operation of resource: gi-addr-policy

gi-addr-policy_schema

gi-addr-policybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {GIADDR policyPUTPOSTDELETEGET
    "policy": "enumeration" GIADDR policy
Options:
 replace
 drop 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GI-ADDR-POLICY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Delete operation of resource: gi-addr-policy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GI-ADDR-POLICY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Retrieve operation of resource: gi-addr-policy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

gi-addr-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {GIADDR policyPUTPOSTDELETEGET
    "policy": "enumeration" GIADDR policy
Options:
 replace
 drop 
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {VRF Helper AddressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF Name
        : {Helper AddressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "gateway-address": "string", GatewayAddress
              "enable": [ null ], Enable helper - deprecated
              "ip-address": "string" IPV4 Address
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {VRF Helper AddressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF Name
        : {Helper AddressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "gateway-address": "string", GatewayAddress
              "enable": [ null ], Enable helper - deprecated
              "ip-address": "string" IPV4 Address
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Delete operation of resource: vrfs

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Retrieve operation of resource: vrfs

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {VRF Helper AddressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF Name
        : {Helper AddressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "gateway-address": "string", GatewayAddress
              "enable": [ null ], Enable helper - deprecated
              "ip-address": "string" IPV4 Address
            }
          ]
        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF Name
    : {Helper AddressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "gateway-address": "string", GatewayAddress
          "enable": [ null ], Enable helper - deprecated
          "ip-address": "string" IPV4 Address
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF Name
    : {Helper AddressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "gateway-address": "string", GatewayAddress
          "enable": [ null ], Enable helper - deprecated
          "ip-address": "string" IPV4 Address
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF Name
    : {Helper AddressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "gateway-address": "string", GatewayAddress
          "enable": [ null ], Enable helper - deprecated
          "ip-address": "string" IPV4 Address
        }
      ]
    }
  }
}

HELPER-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Update operation of resource: helper-addresses

helper-addresses_schema

helper-addressesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Helper AddressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "gateway-address": "string", GatewayAddress
        "enable": [ null ], Enable helper - deprecated
        "ip-address": "string" IPV4 Address
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Create operation of resource: helper-addresses

helper-addresses_schema

helper-addressesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Helper AddressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "gateway-address": "string", GatewayAddress
        "enable": [ null ], Enable helper - deprecated
        "ip-address": "string" IPV4 Address
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Delete operation of resource: helper-addresses

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Retrieve operation of resource: helper-addresses

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

helper-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Helper AddressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "gateway-address": "string", GatewayAddress
        "enable": [ null ], Enable helper - deprecated
        "ip-address": "string" IPV4 Address
      }
    ]
  }
}

HELPER-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Update operation of resource: helper-address

helper-address_schema

helper-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "gateway-address": "string", GatewayAddress
    "enable": [ null ], Enable helper - deprecated
    "ip-address": "string" IPV4 Address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Create operation of resource: helper-address

helper-address_schema

helper-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "gateway-address": "string", GatewayAddress
    "enable": [ null ], Enable helper - deprecated
    "ip-address": "string" IPV4 Address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Delete operation of resource: helper-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Retrieve operation of resource: helper-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

ip-address: string

in path

ID of ip-address

200 OK

helper-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "gateway-address": "string", GatewayAddress
    "enable": [ null ], Enable helper - deprecated
    "ip-address": "string" IPV4 Address
  }
}

RELAY-INFORMATION-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Update operation of resource: relay-information-option

relay-information-option_schema

relay-information-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Relay agent information optionPUTPOSTDELETEGET
    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
    "subscriber-id": "string", Subscriber ID
    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
    : {Enter remote-id valuePUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "remote-id-value": "string" Enter remote-id value
    },
    "allow-untrusted": [ null ], Forward untrusted packets
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "vpn": [ null ], Insert VPN options
    "check": [ null ] Check Relay Agent Information Option in\nserver reply
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Create operation of resource: relay-information-option

relay-information-option_schema

relay-information-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Relay agent information optionPUTPOSTDELETEGET
    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
    "subscriber-id": "string", Subscriber ID
    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
    : {Enter remote-id valuePUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "remote-id-value": "string" Enter remote-id value
    },
    "allow-untrusted": [ null ], Forward untrusted packets
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "vpn": [ null ], Insert VPN options
    "check": [ null ] Check Relay Agent Information Option in\nserver reply
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Delete operation of resource: relay-information-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Retrieve operation of resource: relay-information-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

relay-information-option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Relay agent information optionPUTPOSTDELETEGET
    "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
    "subscriber-id": "string", Subscriber ID
    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco
    : {Enter remote-id valuePUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "remote-id-value": "string" Enter remote-id value
    },
    "allow-untrusted": [ null ], Forward untrusted packets
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "vpn": [ null ], Insert VPN options
    "check": [ null ] Check Relay Agent Information Option in\nserver reply
  }
}

REMOTE-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/remote-id/

Update operation of resource: remote-id

remote-id_schema

remote-idbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enter remote-id valuePUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "remote-id-value": "string" Enter remote-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/remote-id/

Create operation of resource: remote-id

remote-id_schema

remote-idbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enter remote-id valuePUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "remote-id-value": "string" Enter remote-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/remote-id/

Delete operation of resource: remote-id

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/remote-id/

Retrieve operation of resource: remote-id

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

remote-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enter remote-id valuePUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "remote-id-value": "string" Enter remote-id value
  }
}

BROADCAST-POLICY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Update operation of resource: broadcast-policy

broadcast-policy_schema

broadcast-policybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Broadcast Flag policyPUTPOSTDELETEGET
    "policy": "enumeration" Broadcast flag policy
Options:
 ignore
 check
 unicast-always 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-POLICY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Create operation of resource: broadcast-policy

broadcast-policy_schema

broadcast-policybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Broadcast Flag policyPUTPOSTDELETEGET
    "policy": "enumeration" Broadcast flag policy
Options:
 ignore
 check
 unicast-always 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-POLICY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Delete operation of resource: broadcast-policy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-POLICY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Retrieve operation of resource: broadcast-policy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

broadcast-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Broadcast Flag policyPUTPOSTDELETEGET
    "policy": "enumeration" Broadcast flag policy
Options:
 ignore
 check
 unicast-always 
  }
}

PROXY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Update operation of resource: proxy

proxy_schema

proxybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP proxy profilePUTPOSTDELETEGET
    : {Proxy limit leasePUTPOSTDELETEGET
      "limit-lease-count": "string", Limit lease count
range: "1..240000" 
      "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
    },    : {Specify broadcast flagPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 ignore
 check
 unicast-always 
    },
    "secure-arp": [ null ], DHCP IPV4 profile proxy secure-arp enable
    : {Change sessions configurationPUTPOSTDELETEGET
      : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
        : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
          "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
          "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
          "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
        }
      }
    },    : {Authentication Username formatingPUTPOSTDELETEGET
      "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
      "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
    },    : {Specify gateway address policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 giaddr-policy-keep 
    },    : {Insert match keywordPUTPOSTDELETEGET
      : {Table of OptionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
            "def-matchoption": "integer" Match option 60 
          }
        ]
      },      : {Table of OptionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "pattern": "string", Hex pattern string
            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
            "matchoption": "integer", Match option 60 
            "format": "integer" Set constant integer 
          }
        ]
      }
    },    : {DHCPv4 lease proxyPUTPOSTDELETEGET
      "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
      "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
    },    : {List of VRFsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF name
          : {Helper addressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "server-address": "string", IPv4 address
                "gateway-address": "string" Gateway address
              }
            ]
          }
        }
      ]
    },
    "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
    "enable": [ null ], Enable the DHCP IPV4 proxy class
    : {DHCP class tablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {Match optionPUTPOSTDELETEGET
            : {Match optionPUTPOSTDELETEGET
              "pattern": "string", Hex pattern string
              "bit-mask": "string", Bit mask pattern
              "option-type": "enumeration" Match option
Options: 
            },
            "vrf": "string" Match VRF name
          },
          "enable": [ null ], Enable the DHCP IPV4 proxy class
          "class-name": "string", Class name
          : {List of VRFsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper addressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "server-address": "string", IPv4 address
                      "gateway-address": "string" Gateway address
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    },
    "proxy-allow-move": [ null ], Allow dhcp subscriber move
    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255" 
          "option-all": "integer" option all 
        }
      }
    },    : [Relay agent information optionPUTPOSTDELETEGET
      {
        "authenticate": "enumeration", Relay information option authenticate
Options:
 received
 inserted 
        "option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
        "remote-id-xr": [ null ], Insert Remote-id sub-option
        "allow-untrusted": [ null ], Forward untrusted packets
        "remote-id-suppress": [ null ], Suppress Remote ID
        "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
        "remote-id": "string", Remote ID
        "circuit-id": [ null ], Insert Circuit-id sub-option
        "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
        "vpn": [ null ], Insert VPN options
        "check": [ null ] Check relay agent information option in\nserver reply
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Create operation of resource: proxy

proxy_schema

proxybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP proxy profilePUTPOSTDELETEGET
    : {Proxy limit leasePUTPOSTDELETEGET
      "limit-lease-count": "string", Limit lease count
range: "1..240000" 
      "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
    },    : {Specify broadcast flagPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 ignore
 check
 unicast-always 
    },
    "secure-arp": [ null ], DHCP IPV4 profile proxy secure-arp enable
    : {Change sessions configurationPUTPOSTDELETEGET
      : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
        : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
          "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
          "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
          "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
        }
      }
    },    : {Authentication Username formatingPUTPOSTDELETEGET
      "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
      "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
    },    : {Specify gateway address policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 giaddr-policy-keep 
    },    : {Insert match keywordPUTPOSTDELETEGET
      : {Table of OptionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
            "def-matchoption": "integer" Match option 60 
          }
        ]
      },      : {Table of OptionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "pattern": "string", Hex pattern string
            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
            "matchoption": "integer", Match option 60 
            "format": "integer" Set constant integer 
          }
        ]
      }
    },    : {DHCPv4 lease proxyPUTPOSTDELETEGET
      "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
      "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
    },    : {List of VRFsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF name
          : {Helper addressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "server-address": "string", IPv4 address
                "gateway-address": "string" Gateway address
              }
            ]
          }
        }
      ]
    },
    "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
    "enable": [ null ], Enable the DHCP IPV4 proxy class
    : {DHCP class tablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {Match optionPUTPOSTDELETEGET
            : {Match optionPUTPOSTDELETEGET
              "pattern": "string", Hex pattern string
              "bit-mask": "string", Bit mask pattern
              "option-type": "enumeration" Match option
Options: 
            },
            "vrf": "string" Match VRF name
          },
          "enable": [ null ], Enable the DHCP IPV4 proxy class
          "class-name": "string", Class name
          : {List of VRFsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper addressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "server-address": "string", IPv4 address
                      "gateway-address": "string" Gateway address
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    },
    "proxy-allow-move": [ null ], Allow dhcp subscriber move
    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255" 
          "option-all": "integer" option all 
        }
      }
    },    : [Relay agent information optionPUTPOSTDELETEGET
      {
        "authenticate": "enumeration", Relay information option authenticate
Options:
 received
 inserted 
        "option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
        "remote-id-xr": [ null ], Insert Remote-id sub-option
        "allow-untrusted": [ null ], Forward untrusted packets
        "remote-id-suppress": [ null ], Suppress Remote ID
        "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
        "remote-id": "string", Remote ID
        "circuit-id": [ null ], Insert Circuit-id sub-option
        "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
        "vpn": [ null ], Insert VPN options
        "check": [ null ] Check relay agent information option in\nserver reply
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Delete operation of resource: proxy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Retrieve operation of resource: proxy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

proxy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP proxy profilePUTPOSTDELETEGET
    : {Proxy limit leasePUTPOSTDELETEGET
      "limit-lease-count": "string", Limit lease count
range: "1..240000" 
      "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
    },    : {Specify broadcast flagPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 ignore
 check
 unicast-always 
    },
    "secure-arp": [ null ], DHCP IPV4 profile proxy secure-arp enable
    : {Change sessions configurationPUTPOSTDELETEGET
      : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
        : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
          "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
          "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
          "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
        }
      }
    },    : {Authentication Username formatingPUTPOSTDELETEGET
      "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
      "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
    },    : {Specify gateway address policyPUTPOSTDELETEGET
      "policy": "enumeration" Relay information option policy
Options:
 giaddr-policy-keep 
    },    : {Insert match keywordPUTPOSTDELETEGET
      : {Table of OptionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
            "def-matchoption": "integer" Match option 60 
          }
        ]
      },      : {Table of OptionPUTPOSTDELETEGET
        : [No descriptionPUTPOSTDELETEGET
          {
            "pattern": "string", Hex pattern string
            "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
            "matchoption": "integer", Match option 60 
            "format": "integer" Set constant integer 
          }
        ]
      }
    },    : {DHCPv4 lease proxyPUTPOSTDELETEGET
      "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
      "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
    },    : {List of VRFsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF name
          : {Helper addressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "server-address": "string", IPv4 address
                "gateway-address": "string" Gateway address
              }
            ]
          }
        }
      ]
    },
    "delayed-authen-proxy": [ null ], For BNG session, delay the authentication
    "enable": [ null ], Enable the DHCP IPV4 proxy class
    : {DHCP class tablePUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {          : {Match optionPUTPOSTDELETEGET
            : {Match optionPUTPOSTDELETEGET
              "pattern": "string", Hex pattern string
              "bit-mask": "string", Bit mask pattern
              "option-type": "enumeration" Match option
Options: 
            },
            "vrf": "string" Match VRF name
          },
          "enable": [ null ], Enable the DHCP IPV4 proxy class
          "class-name": "string", Class name
          : {List of VRFsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "vrf-name": "string", VRF name
                : {Helper addressesPUTPOSTDELETEGET
                  : [No descriptionPUTPOSTDELETEGET
                    {
                      "server-address": "string", IPv4 address
                      "gateway-address": "string" Gateway address
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    },
    "proxy-allow-move": [ null ], Allow dhcp subscriber move
    : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
      : {option typePUTPOSTDELETEGET
        : {List of optionsPUTPOSTDELETEGET
          "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255" 
          "option-all": "integer" option all 
        }
      }
    },    : [Relay agent information optionPUTPOSTDELETEGET
      {
        "authenticate": "enumeration", Relay information option authenticate
Options:
 received
 inserted 
        "option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
        "remote-id-xr": [ null ], Insert Remote-id sub-option
        "allow-untrusted": [ null ], Forward untrusted packets
        "remote-id-suppress": [ null ], Suppress Remote ID
        "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
        "remote-id": "string", Remote ID
        "circuit-id": [ null ], Insert Circuit-id sub-option
        "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
        "vpn": [ null ], Insert VPN options
        "check": [ null ] Check relay agent information option in\nserver reply
      }
    ]
  }
}

GIADDR - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Update operation of resource: giaddr

giaddr_schema

giaddrbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify gateway address policyPUTPOSTDELETEGET
    "policy": "enumeration" Gateway address policy
Options:
 giaddr-policy-keep 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GIADDR - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Create operation of resource: giaddr

giaddr_schema

giaddrbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify gateway address policyPUTPOSTDELETEGET
    "policy": "enumeration" Gateway address policy
Options:
 giaddr-policy-keep 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GIADDR - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Delete operation of resource: giaddr

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GIADDR - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Retrieve operation of resource: giaddr

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

giaddr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Specify gateway address policyPUTPOSTDELETEGET
    "policy": "enumeration" Gateway address policy
Options:
 giaddr-policy-keep 
  }
}

CLASSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Update operation of resource: classes

classes_schema

classesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP class tablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {Match optionPUTPOSTDELETEGET
          : {Match optionPUTPOSTDELETEGET
            "pattern": "string", Hex pattern string
            "bit-mask": "string", Bit mask pattern
            "option-type": "enumeration" Match option
Options: 
          },
          "vrf": "string" Match VRF name
        },
        "enable": [ null ], Enable the DHCP IPV4 proxy class
        "class-name": "string", Class name
        : {List of VRFsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper addressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "server-address": "string", IPv4 address
                    "gateway-address": "string" Gateway address
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Create operation of resource: classes

classes_schema

classesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCP class tablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {Match optionPUTPOSTDELETEGET
          : {Match optionPUTPOSTDELETEGET
            "pattern": "string", Hex pattern string
            "bit-mask": "string", Bit mask pattern
            "option-type": "enumeration" Match option
Options: 
          },
          "vrf": "string" Match VRF name
        },
        "enable": [ null ], Enable the DHCP IPV4 proxy class
        "class-name": "string", Class name
        : {List of VRFsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper addressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "server-address": "string", IPv4 address
                    "gateway-address": "string" Gateway address
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Delete operation of resource: classes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Retrieve operation of resource: classes

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

classes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP class tablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {        : {Match optionPUTPOSTDELETEGET
          : {Match optionPUTPOSTDELETEGET
            "pattern": "string", Hex pattern string
            "bit-mask": "string", Bit mask pattern
            "option-type": "enumeration" Match option
Options: 
          },
          "vrf": "string" Match VRF name
        },
        "enable": [ null ], Enable the DHCP IPV4 proxy class
        "class-name": "string", Class name
        : {List of VRFsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "vrf-name": "string", VRF name
              : {Helper addressesPUTPOSTDELETEGET
                : [No descriptionPUTPOSTDELETEGET
                  {
                    "server-address": "string", IPv4 address
                    "gateway-address": "string" Gateway address
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

CLASS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Update operation of resource: class

class_schema

classbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    : {Match optionPUTPOSTDELETEGET
      : {Match optionPUTPOSTDELETEGET
        "pattern": "string", Hex pattern string
        "bit-mask": "string", Bit mask pattern
        "option-type": "enumeration" Match option
Options: 
      },
      "vrf": "string" Match VRF name
    },
    "enable": [ null ], Enable the DHCP IPV4 proxy class
    "class-name": "string", Class name
    : {List of VRFsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF name
          : {Helper addressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "server-address": "string", IPv4 address
                "gateway-address": "string" Gateway address
              }
            ]
          }
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Create operation of resource: class

class_schema

classbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    : {Match optionPUTPOSTDELETEGET
      : {Match optionPUTPOSTDELETEGET
        "pattern": "string", Hex pattern string
        "bit-mask": "string", Bit mask pattern
        "option-type": "enumeration" Match option
Options: 
      },
      "vrf": "string" Match VRF name
    },
    "enable": [ null ], Enable the DHCP IPV4 proxy class
    "class-name": "string", Class name
    : {List of VRFsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF name
          : {Helper addressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "server-address": "string", IPv4 address
                "gateway-address": "string" Gateway address
              }
            ]
          }
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Delete operation of resource: class

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Retrieve operation of resource: class

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

class_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    : {Match optionPUTPOSTDELETEGET
      : {Match optionPUTPOSTDELETEGET
        "pattern": "string", Hex pattern string
        "bit-mask": "string", Bit mask pattern
        "option-type": "enumeration" Match option
Options: 
      },
      "vrf": "string" Match VRF name
    },
    "enable": [ null ], Enable the DHCP IPV4 proxy class
    "class-name": "string", Class name
    : {List of VRFsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "vrf-name": "string", VRF name
          : {Helper addressesPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "server-address": "string", IPv4 address
                "gateway-address": "string" Gateway address
              }
            ]
          }
        }
      ]
    }
  }
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Update operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Match optionPUTPOSTDELETEGET
    : {Match optionPUTPOSTDELETEGET
      "pattern": "string", Hex pattern string
      "bit-mask": "string", Bit mask pattern
      "option-type": "enumeration" Match option
Options: 
    },
    "vrf": "string" Match VRF name
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Create operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Match optionPUTPOSTDELETEGET
    : {Match optionPUTPOSTDELETEGET
      "pattern": "string", Hex pattern string
      "bit-mask": "string", Bit mask pattern
      "option-type": "enumeration" Match option
Options: 
    },
    "vrf": "string" Match VRF name
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Delete operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Retrieve operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Match optionPUTPOSTDELETEGET
    : {Match optionPUTPOSTDELETEGET
      "pattern": "string", Hex pattern string
      "bit-mask": "string", Bit mask pattern
      "option-type": "enumeration" Match option
Options: 
    },
    "vrf": "string" Match VRF name
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Update operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Match optionPUTPOSTDELETEGET
    "pattern": "string", Hex pattern string
    "bit-mask": "string", Bit mask pattern
    "option-type": "enumeration" Match option
Options: 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Create operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {Match optionPUTPOSTDELETEGET
    "pattern": "string", Hex pattern string
    "bit-mask": "string", Bit mask pattern
    "option-type": "enumeration" Match option
Options: 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Delete operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Retrieve operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Match optionPUTPOSTDELETEGET
    "pattern": "string", Hex pattern string
    "bit-mask": "string", Bit mask pattern
    "option-type": "enumeration" Match option
Options: 
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {List of VRFsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF name
        : {Helper addressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "server-address": "string", IPv4 address
              "gateway-address": "string" Gateway address
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

Request Content-Types: application/json

Request Example

{  : {List of VRFsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF name
        : {Helper addressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "server-address": "string", IPv4 address
              "gateway-address": "string" Gateway address
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Delete operation of resource: vrfs

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Retrieve operation of resource: vrfs

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

200 OK

vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {List of VRFsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF name
        : {Helper addressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "server-address": "string", IPv4 address
              "gateway-address": "string" Gateway address
            }
          ]
        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF name
    : {Helper addressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "server-address": "string", IPv4 address
          "gateway-address": "string" Gateway address
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF name
    : {Helper addressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "server-address": "string", IPv4 address
          "gateway-address": "string" Gateway address
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

200 OK

vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF name
    : {Helper addressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "server-address": "string", IPv4 address
          "gateway-address": "string" Gateway address
        }
      ]
    }
  }
}

HELPER-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Update operation of resource: helper-addresses

helper-addresses_schema

helper-addressesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Helper addressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "server-address": "string", IPv4 address
        "gateway-address": "string" Gateway address
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Create operation of resource: helper-addresses

helper-addresses_schema

helper-addressesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Helper addressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "server-address": "string", IPv4 address
        "gateway-address": "string" Gateway address
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Delete operation of resource: helper-addresses

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Retrieve operation of resource: helper-addresses

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

200 OK

helper-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Helper addressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "server-address": "string", IPv4 address
        "gateway-address": "string" Gateway address
      }
    ]
  }
}

HELPER-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Update operation of resource: helper-address

helper-address_schema

helper-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "server-address": "string", IPv4 address
    "gateway-address": "string" Gateway address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Create operation of resource: helper-address

helper-address_schema

helper-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "server-address": "string", IPv4 address
    "gateway-address": "string" Gateway address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Delete operation of resource: helper-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Retrieve operation of resource: helper-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

class-name: string

in path

ID of class-name

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

200 OK

helper-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "server-address": "string", IPv4 address
    "gateway-address": "string" Gateway address
  }
}

AUTH-USERNAME - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Update operation of resource: auth-username

auth-username_schema

auth-usernamebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Authentication Username formatingPUTPOSTDELETEGET
    "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
    "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTH-USERNAME - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Create operation of resource: auth-username

auth-username_schema

auth-usernamebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Authentication Username formatingPUTPOSTDELETEGET
    "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
    "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTH-USERNAME - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Delete operation of resource: auth-username

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTH-USERNAME - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Retrieve operation of resource: auth-username

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

auth-username_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Authentication Username formatingPUTPOSTDELETEGET
    "arg1": "enumeration", Username Formatting first argument 
Options:
 auth-username-mac
 auth-username-giaddr 
    "arg2": "enumeration" Username Formatting second argument 
Options:
 auth-username-mac
 auth-username-giaddr 
  }
}

RELAY-INFORMATION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Update operation of resource: relay-information

relay-information_schema

relay-informationbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Relay agent information optionPUTPOSTDELETEGET
    "authenticate": "enumeration", Relay information option authenticate
Options:
 received
 inserted 
    "option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
    "remote-id-xr": [ null ], Insert Remote-id sub-option
    "allow-untrusted": [ null ], Forward untrusted packets
    "remote-id-suppress": [ null ], Suppress Remote ID
    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
    "remote-id": "string", Remote ID
    "circuit-id": [ null ], Insert Circuit-id sub-option
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "vpn": [ null ], Insert VPN options
    "check": [ null ] Check relay agent information option in\nserver reply
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Create operation of resource: relay-information

relay-information_schema

relay-informationbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Relay agent information optionPUTPOSTDELETEGET
    "authenticate": "enumeration", Relay information option authenticate
Options:
 received
 inserted 
    "option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
    "remote-id-xr": [ null ], Insert Remote-id sub-option
    "allow-untrusted": [ null ], Forward untrusted packets
    "remote-id-suppress": [ null ], Suppress Remote ID
    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
    "remote-id": "string", Remote ID
    "circuit-id": [ null ], Insert Circuit-id sub-option
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "vpn": [ null ], Insert VPN options
    "check": [ null ] Check relay agent information option in\nserver reply
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Delete operation of resource: relay-information

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Retrieve operation of resource: relay-information

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

relay-information_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Relay agent information optionPUTPOSTDELETEGET
    "authenticate": "enumeration", Relay information option authenticate
Options:
 received
 inserted 
    "option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
    "remote-id-xr": [ null ], Insert Remote-id sub-option
    "allow-untrusted": [ null ], Forward untrusted packets
    "remote-id-suppress": [ null ], Suppress Remote ID
    "vpn-mode": "enumeration", VPN Mode
Options:
 rfc
 cisco 
    "remote-id": "string", Remote ID
    "circuit-id": [ null ], Insert Circuit-id sub-option
    "policy": "enumeration", Relay information option policy
Options:
 replace
 keep
 drop
 encapsulate 
    "vpn": [ null ], Insert VPN options
    "check": [ null ] Check relay agent information option in\nserver reply
  }
}

DHCP-TO-AAA - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Update operation of resource: dhcp-to-aaa

dhcp-to-aaa_schema

dhcp-to-aaabody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option": "integer", List of options
range: "1..255" 
        "option-all": "integer" option all 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Create operation of resource: dhcp-to-aaa

dhcp-to-aaa_schema

dhcp-to-aaabody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option": "integer", List of options
range: "1..255" 
        "option-all": "integer" option all 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Delete operation of resource: dhcp-to-aaa

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Retrieve operation of resource: dhcp-to-aaa

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

dhcp-to-aaa_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enable to provide the list of options need\nto send to aaaPUTPOSTDELETEGET
    : {option typePUTPOSTDELETEGET
      : {List of optionsPUTPOSTDELETEGET
        "option": "integer", List of options
range: "1..255" 
        "option-all": "integer" option all 
      }
    }
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Update operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option": "integer", List of options
range: "1..255" 
      "option-all": "integer" option all 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Create operation of resource: option

option_schema

optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option": "integer", List of options
range: "1..255" 
      "option-all": "integer" option all 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Delete operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Retrieve operation of resource: option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {option typePUTPOSTDELETEGET
    : {List of optionsPUTPOSTDELETEGET
      "option": "integer", List of options
range: "1..255" 
      "option-all": "integer" option all 
    }
  }
}

LIST - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Update operation of resource: list

list_schema

listbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of optionsPUTPOSTDELETEGET
    "option": "integer", List of options
range: "1..255" 
    "option-all": "integer" option all 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Create operation of resource: list

list_schema

listbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of optionsPUTPOSTDELETEGET
    "option": "integer", List of options
range: "1..255" 
    "option-all": "integer" option all 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Delete operation of resource: list

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Retrieve operation of resource: list

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

list_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {List of optionsPUTPOSTDELETEGET
    "option": "integer", List of options
range: "1..255" 
    "option-all": "integer" option all 
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of VRFsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF name
        : {Helper addressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "server-address": "string", IPv4 address
              "gateway-address": "string" Gateway address
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {List of VRFsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF name
        : {Helper addressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "server-address": "string", IPv4 address
              "gateway-address": "string" Gateway address
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Delete operation of resource: vrfs

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Retrieve operation of resource: vrfs

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {List of VRFsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "vrf-name": "string", VRF name
        : {Helper addressesPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "server-address": "string", IPv4 address
              "gateway-address": "string" Gateway address
            }
          ]
        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF name
    : {Helper addressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "server-address": "string", IPv4 address
          "gateway-address": "string" Gateway address
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF name
    : {Helper addressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "server-address": "string", IPv4 address
          "gateway-address": "string" Gateway address
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "vrf-name": "string", VRF name
    : {Helper addressesPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "server-address": "string", IPv4 address
          "gateway-address": "string" Gateway address
        }
      ]
    }
  }
}

HELPER-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Update operation of resource: helper-addresses

helper-addresses_schema

helper-addressesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Helper addressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "server-address": "string", IPv4 address
        "gateway-address": "string" Gateway address
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Create operation of resource: helper-addresses

helper-addresses_schema

helper-addressesbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : {Helper addressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "server-address": "string", IPv4 address
        "gateway-address": "string" Gateway address
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Delete operation of resource: helper-addresses

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Retrieve operation of resource: helper-addresses

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

200 OK

helper-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Helper addressesPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "server-address": "string", IPv4 address
        "gateway-address": "string" Gateway address
      }
    ]
  }
}

HELPER-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Update operation of resource: helper-address

helper-address_schema

helper-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "server-address": "string", IPv4 address
    "gateway-address": "string" Gateway address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Create operation of resource: helper-address

helper-address_schema

helper-addressbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "server-address": "string", IPv4 address
    "gateway-address": "string" Gateway address
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Delete operation of resource: helper-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Retrieve operation of resource: helper-address

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

vrf-name: string

in path

ID of vrf-name

server-address: string

in path

ID of server-address

200 OK

helper-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "server-address": "string", IPv4 address
    "gateway-address": "string" Gateway address
  }
}

SESSIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Update operation of resource: sessions

sessions_schema

sessionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Change sessions configurationPUTPOSTDELETEGET
    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Create operation of resource: sessions

sessions_schema

sessionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Change sessions configurationPUTPOSTDELETEGET
    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
      }
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Delete operation of resource: sessions

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Retrieve operation of resource: sessions

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

sessions_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Change sessions configurationPUTPOSTDELETEGET
    : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
      : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
        "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
        "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
        "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
      }
    }
  }
}

PROXY-THROTTLE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Update operation of resource: proxy-throttle-type

proxy-throttle-type_schema

proxy-throttle-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-THROTTLE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Create operation of resource: proxy-throttle-type

proxy-throttle-type_schema

proxy-throttle-typebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-THROTTLE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Delete operation of resource: proxy-throttle-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-THROTTLE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Retrieve operation of resource: proxy-throttle-type

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

proxy-throttle-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Throttle DHCP sessions based on MAC\naddressPUTPOSTDELETEGET
    : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
      "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
      "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
      "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
    }
  }
}

PROXY-MAC-THROTTLE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Update operation of resource: proxy-mac-throttle

proxy-mac-throttle_schema

proxy-mac-throttlebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-MAC-THROTTLE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Create operation of resource: proxy-mac-throttle

proxy-mac-throttle_schema

proxy-mac-throttlebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-MAC-THROTTLE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Delete operation of resource: proxy-mac-throttle

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-MAC-THROTTLE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Retrieve operation of resource: proxy-mac-throttle

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

proxy-mac-throttle_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Throttle DHCP sessions from any one MAC\naddressPUTPOSTDELETEGET
    "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535" 
    "num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second" 
    "num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second" 
  }
}

LIMIT-LEASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Update operation of resource: limit-lease

limit-lease_schema

limit-leasebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Proxy limit leasePUTPOSTDELETEGET
    "limit-lease-count": "string", Limit lease count
range: "1..240000" 
    "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMIT-LEASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Create operation of resource: limit-lease

limit-lease_schema

limit-leasebody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Proxy limit leasePUTPOSTDELETEGET
    "limit-lease-count": "string", Limit lease count
range: "1..240000" 
    "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMIT-LEASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Delete operation of resource: limit-lease

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMIT-LEASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Retrieve operation of resource: limit-lease

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

limit-lease_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Proxy limit leasePUTPOSTDELETEGET
    "limit-lease-count": "string", Limit lease count
range: "1..240000" 
    "limit-type": "enumeration" Lease limit type
Options:
 interface
 circuit-id
 remote-id
 circuit-id-remote-id 
  }
}

LEASE-PROXY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Update operation of resource: lease-proxy

lease-proxy_schema

lease-proxybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCPv4 lease proxyPUTPOSTDELETEGET
    "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
    "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-PROXY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Create operation of resource: lease-proxy

lease-proxy_schema

lease-proxybody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {DHCPv4 lease proxyPUTPOSTDELETEGET
    "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
    "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-PROXY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Delete operation of resource: lease-proxy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-PROXY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Retrieve operation of resource: lease-proxy

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

lease-proxy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCPv4 lease proxyPUTPOSTDELETEGET
    "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
    "client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295" 
  }
}

BROADCAST-FLAG - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Update operation of resource: broadcast-flag

broadcast-flag_schema

broadcast-flagbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify broadcast flagPUTPOSTDELETEGET
    "policy": "enumeration" Broadcast flag policy
Options:
 ignore
 check
 unicast-always 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Create operation of resource: broadcast-flag

broadcast-flag_schema

broadcast-flagbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Specify broadcast flagPUTPOSTDELETEGET
    "policy": "enumeration" Broadcast flag policy
Options:
 ignore
 check
 unicast-always 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Delete operation of resource: broadcast-flag

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Retrieve operation of resource: broadcast-flag

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

broadcast-flag_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Specify broadcast flagPUTPOSTDELETEGET
    "policy": "enumeration" Broadcast flag policy
Options:
 ignore
 check
 unicast-always 
  }
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Update operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
          "def-matchoption": "integer" Match option 60 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
          "matchoption": "integer", Match option 60 
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Create operation of resource: match

match_schema

matchbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
          "def-matchoption": "integer" Match option 60 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
          "matchoption": "integer", Match option 60 
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Delete operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Retrieve operation of resource: match

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Insert match keywordPUTPOSTDELETEGET
    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
          "def-matchoption": "integer" Match option 60 
        }
      ]
    },    : {Table of OptionPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "pattern": "string", Enter hex pattern string
          "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
          "matchoption": "integer", Match option 60 
          "format": "integer" Set constant integer 
        }
      ]
    }
  }
}

DEF-OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Update operation of resource: def-options

def-options_schema

def-optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
        "def-matchoption": "integer" Match option 60 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Create operation of resource: def-options

def-options_schema

def-optionsbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
        "def-matchoption": "integer" Match option 60 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Delete operation of resource: def-options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Retrieve operation of resource: def-options

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

def-options_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
        "def-matchoption": "integer" Match option 60 
      }
    ]
  }
}

DEF-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Update operation of resource: def-option

def-option_schema

def-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
    "def-matchoption": "integer" Match option 60 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Create operation of resource: def-option

def-option_schema

def-optionbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
    "def-matchoption": "integer" Match option 60 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Delete operation of resource: def-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Retrieve operation of resource: def-option

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

def-matchoption: string

in path

ID of def-matchoption

200 OK

def-option_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "def-matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
    "def-matchoption": "integer" Match option 60 
  }
}

OPTION-FILTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Update operation of resource: option-filters

option-filters_schema

option-filtersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
        "matchoption": "integer", Match option 60 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Create operation of resource: option-filters

option-filters_schema

option-filtersbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

Request Content-Types: application/json

Request Example

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
        "matchoption": "integer", Match option 60 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Delete operation of resource: option-filters

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Retrieve operation of resource: option-filters

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

200 OK

option-filters_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Table of OptionPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "pattern": "string", Enter hex pattern string
        "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
        "matchoption": "integer", Match option 60 
        "format": "integer" Set constant integer 
      }
    ]
  }
}

OPTION-FILTER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Update operation of resource: option-filter

option-filter_schema

option-filterbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "pattern": "string", Enter hex pattern string
    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
    "matchoption": "integer", Match option 60 
    "format": "integer" Set constant integer 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Create operation of resource: option-filter

option-filter_schema

option-filterbody object

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

Request Content-Types: application/json

Request Example

{  : {No descriptionPUTPOSTDELETEGET
    "pattern": "string", Enter hex pattern string
    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
    "matchoption": "integer", Match option 60 
    "format": "integer" Set constant integer 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Delete operation of resource: option-filter

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Retrieve operation of resource: option-filter

profile-name: string

in path

ID of profile-name

mode: string

in path

ID of mode

matchoption pattern format: string

in path

ID of matchoption pattern format

200 OK

option-filter_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {No descriptionPUTPOSTDELETEGET
    "pattern": "string", Enter hex pattern string
    "matchaction": "enumeration", Vendor action
Options:
 allow
 drop
 relay 
    "matchoption": "integer", Match option 60 
    "format": "integer" Set constant integer 
  }
}

DATABASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Update operation of resource: database

database_schema

databasebody object

Request Content-Types: application/json

Request Example

{  : {Enable DHCP binding database storage to file\nsystemPUTPOSTDELETEGET
    "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10" 
    "incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1" 
    "proxy": [ null ], Enable DHCP proxy binding database storage to\nfile system
    "snoop": [ null ], Enable DHCP snoop binding database storage to\nfile system
    "server": [ null ] Enable DHCP server binding database storage to\nfile system
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATABASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Create operation of resource: database

database_schema

databasebody object

Request Content-Types: application/json

Request Example

{  : {Enable DHCP binding database storage to file\nsystemPUTPOSTDELETEGET
    "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10" 
    "incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1" 
    "proxy": [ null ], Enable DHCP proxy binding database storage to\nfile system
    "snoop": [ null ], Enable DHCP snoop binding database storage to\nfile system
    "server": [ null ] Enable DHCP server binding database storage to\nfile system
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATABASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Delete operation of resource: database

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATABASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Retrieve operation of resource: database

200 OK

database_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Enable DHCP binding database storage to file\nsystemPUTPOSTDELETEGET
    "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10" 
    "incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1" 
    "proxy": [ null ], Enable DHCP proxy binding database storage to\nfile system
    "snoop": [ null ], Enable DHCP snoop binding database storage to\nfile system
    "server": [ null ] Enable DHCP server binding database storage to\nfile system
  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 Interface TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "interface-name": "string", Interface Name
        : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
          : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "client-id": "string", Client Id
range: "0..4294967295" 
                "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
                "static-address": "string", IP address
                "mac-address": "string" MACAddress
              }
            ]
          }
        },        : {Profile name and modePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
        },        : {DHCP IPv4 Server informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 relay informationPUTPOSTDELETEGET
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
          : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "circuit-id-value": "string" Enter circuit-id value
          }
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json

Request Example

{  : {DHCP IPV4 Interface TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "interface-name": "string", Interface Name
        : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
          : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "client-id": "string", Client Id
range: "0..4294967295" 
                "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
                "static-address": "string", IP address
                "mac-address": "string" MACAddress
              }
            ]
          }
        },        : {Profile name and modePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
        },        : {DHCP IPv4 Server informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 relay informationPUTPOSTDELETEGET
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
          : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "circuit-id-value": "string" Enter circuit-id value
          }
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Retrieve operation of resource: interfaces

200 OK

interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPV4 Interface TablePUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "interface-name": "string", Interface Name
        : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
          : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
            : [No descriptionPUTPOSTDELETEGET
              {
                "client-id": "string", Client Id
range: "0..4294967295" 
                "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
                "static-address": "string", IP address
                "mac-address": "string" MACAddress
              }
            ]
          }
        },        : {Profile name and modePUTPOSTDELETEGET
          "profile-name": "string", Profile name
          "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
        },        : {DHCP IPv4 Server informationPUTPOSTDELETEGET
          "profile": "string", Interface profile name
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 relay informationPUTPOSTDELETEGET
          : {Circuit ID valuePUTPOSTDELETEGET
            "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
            "circuit-id": "string", DHCP IPv4 circuit ID value
            "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
            "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          }
        },        : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
          : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
            "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
            "circuit-id-value": "string" Enter circuit-id value
          }
        }
      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "interface-name": "string", Interface Name
      : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
        : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "client-id": "string", Client Id
range: "0..4294967295" 
              "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
              "static-address": "string", IP address
              "mac-address": "string" MACAddress
            }
          ]
        }
      },      : {Profile name and modePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
      },      : {DHCP IPv4 Server informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 relay informationPUTPOSTDELETEGET
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
        : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
          "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
          "circuit-id-value": "string" Enter circuit-id value
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "interface-name": "string", Interface Name
      : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
        : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "client-id": "string", Client Id
range: "0..4294967295" 
              "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
              "static-address": "string", IP address
              "mac-address": "string" MACAddress
            }
          ]
        }
      },      : {Profile name and modePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
      },      : {DHCP IPv4 Server informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 relay informationPUTPOSTDELETEGET
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
        : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
          "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
          "circuit-id-value": "string" Enter circuit-id value
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string

in path

ID of interface-name

200 OK

interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {
      "interface-name": "string", Interface Name
      : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
        : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
          : [No descriptionPUTPOSTDELETEGET
            {
              "client-id": "string", Client Id
range: "0..4294967295" 
              "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
              "static-address": "string", IP address
              "mac-address": "string" MACAddress
            }
          ]
        }
      },      : {Profile name and modePUTPOSTDELETEGET
        "profile-name": "string", Profile name
        "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
      },      : {DHCP IPv4 Server informationPUTPOSTDELETEGET
        "profile": "string", Interface profile name
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 relay informationPUTPOSTDELETEGET
        : {Circuit ID valuePUTPOSTDELETEGET
          "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
          "circuit-id": "string", DHCP IPv4 circuit ID value
          "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
          "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
        }
      },      : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
        : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
          "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
          "circuit-id-value": "string" Enter circuit-id value
        }
      }
    }
  ]
}

PROXY-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Update operation of resource: proxy-interface

proxy-interface_schema

proxy-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Create operation of resource: proxy-interface

proxy-interface_schema

proxy-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Delete operation of resource: proxy-interface

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Retrieve operation of resource: proxy-interface

interface-name: string

in path

ID of interface-name

200 OK

proxy-interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPv4 proxy informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Update operation of resource: dhcp-circuit-id

dhcp-circuit-id_schema

dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Create operation of resource: dhcp-circuit-id

dhcp-circuit-id_schema

dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Delete operation of resource: dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Retrieve operation of resource: dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

dhcp-circuit-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

BASE-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Update operation of resource: base-interface

base-interface_schema

base-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Create operation of resource: base-interface

base-interface_schema

base-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Delete operation of resource: base-interface

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Retrieve operation of resource: base-interface

interface-name: string

in path

ID of interface-name

200 OK

base-interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPv4 Base profile informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

BASE-DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Update operation of resource: base-dhcp-circuit-id

base-dhcp-circuit-id_schema

base-dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Create operation of resource: base-dhcp-circuit-id

base-dhcp-circuit-id_schema

base-dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Delete operation of resource: base-dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Retrieve operation of resource: base-dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

base-dhcp-circuit-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

RELAY-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Update operation of resource: relay-interface

relay-interface_schema

relay-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 relay informationPUTPOSTDELETEGET
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Create operation of resource: relay-interface

relay-interface_schema

relay-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 relay informationPUTPOSTDELETEGET
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Delete operation of resource: relay-interface

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Retrieve operation of resource: relay-interface

interface-name: string

in path

ID of interface-name

200 OK

relay-interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPv4 relay informationPUTPOSTDELETEGET
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

RELAY-DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Update operation of resource: relay-dhcp-circuit-id

relay-dhcp-circuit-id_schema

relay-dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Create operation of resource: relay-dhcp-circuit-id

relay-dhcp-circuit-id_schema

relay-dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Delete operation of resource: relay-dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Retrieve operation of resource: relay-dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

relay-dhcp-circuit-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

STATIC-MODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Update operation of resource: static-mode

static-mode_schema

static-modebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
    : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "client-id": "string", Client Id
range: "0..4294967295" 
          "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
          "static-address": "string", IP address
          "mac-address": "string" MACAddress
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-MODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Create operation of resource: static-mode

static-mode_schema

static-modebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
    : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "client-id": "string", Client Id
range: "0..4294967295" 
          "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
          "static-address": "string", IP address
          "mac-address": "string" MACAddress
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-MODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Delete operation of resource: static-mode

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-MODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Retrieve operation of resource: static-mode

interface-name: string

in path

ID of interface-name

200 OK

static-mode_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Static Table Entries containing MAC address to\nIP address bindingsPUTPOSTDELETEGET
    : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
      : [No descriptionPUTPOSTDELETEGET
        {
          "client-id": "string", Client Id
range: "0..4294967295" 
          "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
          "static-address": "string", IP address
          "mac-address": "string" MACAddress
        }
      ]
    }
  }
}

STATICS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Update operation of resource: statics

statics_schema

staticsbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "client-id": "string", Client Id
range: "0..4294967295" 
        "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
        "static-address": "string", IP address
        "mac-address": "string" MACAddress
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATICS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Create operation of resource: statics

statics_schema

staticsbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "client-id": "string", Client Id
range: "0..4294967295" 
        "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
        "static-address": "string", IP address
        "mac-address": "string" MACAddress
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATICS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Delete operation of resource: statics

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATICS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Retrieve operation of resource: statics

interface-name: string

in path

ID of interface-name

200 OK

statics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Static Table Entries containing MAC address\nto IP address bindingsPUTPOSTDELETEGET
    : [No descriptionPUTPOSTDELETEGET
      {
        "client-id": "string", Client Id
range: "0..4294967295" 
        "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
        "static-address": "string", IP address
        "mac-address": "string" MACAddress
      }
    ]
  }
}

STATIC - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Update operation of resource: static

static_schema

staticbody object

interface-name: string

in path

ID of interface-name

mac-address client-id layer: string

in path

ID of mac-address client-id layer

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "client-id": "string", Client Id
range: "0..4294967295" 
      "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
      "static-address": "string", IP address
      "mac-address": "string" MACAddress
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Create operation of resource: static

static_schema

staticbody object

interface-name: string

in path

ID of interface-name

mac-address client-id layer: string

in path

ID of mac-address client-id layer

Request Content-Types: application/json

Request Example

{  : [No descriptionPUTPOSTDELETEGET
    {
      "client-id": "string", Client Id
range: "0..4294967295" 
      "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
      "static-address": "string", IP address
      "mac-address": "string" MACAddress
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Delete operation of resource: static

interface-name: string

in path

ID of interface-name

mac-address client-id layer: string

in path

ID of mac-address client-id layer

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Retrieve operation of resource: static

interface-name: string

in path

ID of interface-name

mac-address client-id layer: string

in path

ID of mac-address client-id layer

200 OK

static_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [No descriptionPUTPOSTDELETEGET
    {
      "client-id": "string", Client Id
range: "0..4294967295" 
      "layer": "enumeration", DHCP IPV4 Static layer
Options:
 layer2
 layer3 
      "static-address": "string", IP address
      "mac-address": "string" MACAddress
    }
  ]
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Update operation of resource: profile

profile_schema

profilebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Profile name and modePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Create operation of resource: profile

profile_schema

profilebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Profile name and modePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Delete operation of resource: profile

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Retrieve operation of resource: profile

interface-name: string

in path

ID of interface-name

200 OK

profile_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Profile name and modePUTPOSTDELETEGET
    "profile-name": "string", Profile name
    "mode": "enumeration" DHCP mode
Options:
 base
 relay
 snoop
 server
 proxy
 base2 
  }
}

SERVER-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Update operation of resource: server-interface

server-interface_schema

server-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 Server informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Create operation of resource: server-interface

server-interface_schema

server-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 Server informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Delete operation of resource: server-interface

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Retrieve operation of resource: server-interface

interface-name: string

in path

ID of interface-name

200 OK

server-interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPv4 Server informationPUTPOSTDELETEGET
    "profile": "string", Interface profile name
    : {Circuit ID valuePUTPOSTDELETEGET
      "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
      "circuit-id": "string", DHCP IPv4 circuit ID value
      "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
      "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    }
  }
}

SERVER-DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Update operation of resource: server-dhcp-circuit-id

server-dhcp-circuit-id_schema

server-dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Create operation of resource: server-dhcp-circuit-id

server-dhcp-circuit-id_schema

server-dhcp-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Delete operation of resource: server-dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Retrieve operation of resource: server-dhcp-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

server-dhcp-circuit-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Circuit ID valuePUTPOSTDELETEGET
    "argument10": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument11": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument12": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument13": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument14": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument15": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument16": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "format": "enumeration", Format String
Options:
 no-format
 hex
 ascii
 extended 
    "circuit-id": "string", DHCP IPv4 circuit ID value
    "argument6": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument7": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument4": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument5": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument2": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument3": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument1": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument8": "enumeration", Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
    "argument9": "enumeration" Argument
Options:
 physical-chassis
 physical-slot
 physical-sub-slot
 physical-port
 physical-sub-port
 inner-vlan-id
 outer-vlan-id
 l2-interface
 l3-interface
 host-name 
  }
}

SNOOP-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Update operation of resource: snoop-interface

snoop-interface_schema

snoop-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
    : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "circuit-id-value": "string" Enter circuit-id value
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Create operation of resource: snoop-interface

snoop-interface_schema

snoop-interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
    : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "circuit-id-value": "string" Enter circuit-id value
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Delete operation of resource: snoop-interface

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Retrieve operation of resource: snoop-interface

interface-name: string

in path

ID of interface-name

200 OK

snoop-interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {DHCP IPv4 snoop informationPUTPOSTDELETEGET
    : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
      "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
      "circuit-id-value": "string" Enter circuit-id value
    }
  }
}

SNOOP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Update operation of resource: snoop-circuit-id

snoop-circuit-id_schema

snoop-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "circuit-id-value": "string" Enter circuit-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Create operation of resource: snoop-circuit-id

snoop-circuit-id_schema

snoop-circuit-idbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "circuit-id-value": "string" Enter circuit-id value
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Delete operation of resource: snoop-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Retrieve operation of resource: snoop-circuit-id

interface-name: string

in path

ID of interface-name

200 OK

snoop-circuit-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Configure circuit ID for snoop 1. Hex 2.\nASCIIPUTPOSTDELETEGET
    "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2" 
    "circuit-id-value": "string" Enter circuit-id value
  }
}

DUPLICATE-MAC-ALLOWED - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Update operation of resource: duplicate-mac-allowed

duplicate-mac-allowed_schema

duplicate-mac-allowedbody object

Request Content-Types: application/json

Request Example

{  : {Allow Duplicate MAC AddressPUTPOSTDELETEGET
    "duplicate-mac": [ null ], Duplicate mac is allowed
    "exclude-vlan": [ null ], Exclude vlan
    "include-giaddr": [ null ] Include giaddr
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUPLICATE-MAC-ALLOWED - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Create operation of resource: duplicate-mac-allowed

duplicate-mac-allowed_schema

duplicate-mac-allowedbody object

Request Content-Types: application/json

Request Example

{  : {Allow Duplicate MAC AddressPUTPOSTDELETEGET
    "duplicate-mac": [ null ], Duplicate mac is allowed
    "exclude-vlan": [ null ], Exclude vlan
    "include-giaddr": [ null ] Include giaddr
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUPLICATE-MAC-ALLOWED - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Delete operation of resource: duplicate-mac-allowed

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUPLICATE-MAC-ALLOWED - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Retrieve operation of resource: duplicate-mac-allowed

200 OK

duplicate-mac-allowed_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Allow Duplicate MAC AddressPUTPOSTDELETEGET
    "duplicate-mac": [ null ], Duplicate mac is allowed
    "exclude-vlan": [ null ], Exclude vlan
    "include-giaddr": [ null ] Include giaddr
  }
}

RATE-LIMIT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Update operation of resource: rate-limit

rate-limit_schema

rate-limitbody object

Request Content-Types: application/json

Request Example

{  : {Rate limit ingress packetsPUTPOSTDELETEGET
    "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200" 
    "num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RATE-LIMIT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Create operation of resource: rate-limit

rate-limit_schema

rate-limitbody object

Request Content-Types: application/json

Request Example

{  : {Rate limit ingress packetsPUTPOSTDELETEGET
    "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200" 
    "num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100" 
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RATE-LIMIT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Delete operation of resource: rate-limit

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RATE-LIMIT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Retrieve operation of resource: rate-limit

200 OK

rate-limit_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : {Rate limit ingress packetsPUTPOSTDELETEGET
    "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200" 
    "num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100" 
  }
}

Cisco-IOS-XR-ipv4-dhcpd-cfg API API Reference

API Endpoint

URL '/' code: %2F

Schemes: http

Version: 1.0.0

Leaf Color Code:

Paths

IPV4-DHCPD - Update

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

IPV4-DHCPD - Create

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

IPV4-DHCPD - Delete

Response Content-Types: application/json

IPV4-DHCPD - Retrieve

Response Content-Types: application/json

Response Example (200 OK)

VRFS - Update

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

VRFS - Create

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

VRFS - Delete

Response Content-Types: application/json

VRFS - Retrieve

Response Content-Types: application/json

Response Example (200 OK)

VRF - Update

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

VRF - Create

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

VRF - Delete

Response Content-Types: application/json

VRF - Retrieve

Response Content-Types: application/json

Response Example (200 OK)

PROFILE - Update

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

PROFILE - Create

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

PROFILE - Delete

Response Content-Types: application/json

PROFILE - Retrieve

Response Content-Types: application/json

Response Example (200 OK)

PROFILES - Update

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

PROFILES - Create

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

PROFILES - Delete

Response Content-Types: application/json

PROFILES - Retrieve

Response Content-Types: application/json

Response Example (200 OK)

PROFILE - Update

Request Content-Types: application/json

Request Example

Response Content-Types: application/json

PROFILE - Create

Request Content-Types: application/json

Request Example

Response Content-Types: application/json